Net3 API Interface for Customer Portal

<back to all web services

ScheduledHost

Requires Authentication
The following routes are available for this service:
GET/schedule/host/{hostId}Return Schedule for a given Host.
POST/schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode}Add a Schedule to the Host for a specific Datacenter.
POST/schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode}/{hostLocationId}
POST,PUT/schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode}/{precedence}/{delayStart}/{id]Update a Schedule's settings for given Host for Delay and Precedence.
POST/schedule/host/{hostId}/{scheduleId}/{delete}Remove a Schedule from a given Host
ScheduledHost Parameters:
NameParameterData TypeRequiredDescription
idpathGuidNo
scheduleIdpathGuidNo
hostIdpathstringNo
hostNamepathstringNo
hostDatacenterCodepathstringNo

Allowable Values

  • GMU
  • SPA
  • LAS
  • DEV
  • VCD
  • AWS
  • GCP
  • UAT
  • AZU
  • AUV
  • ATL
hostLocationIdpathGuidNo
precedencepathintNo
delayStartpathintNo
deletepathboolNo
ScheduleBase Parameters:
NameParameterData TypeRequiredDescription
companyIdformGuidNo
userIdformGuidNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
ScheduledHostResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformObjectNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"00000000000000000000000000000000","scheduleId":"00000000000000000000000000000000","hostId":"String","hostName":"String","hostDatacenterCode":"String","hostLocationId":"00000000000000000000000000000000","precedence":0,"delayStart":0,"delete":false,"companyId":"00000000000000000000000000000000","userId":"00000000000000000000000000000000","sessionId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}