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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ScheduledHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <sessionId>String</sessionId>
  <companyId>00000000-0000-0000-0000-000000000000</companyId>
  <userId>00000000-0000-0000-0000-000000000000</userId>
  <delayStart>0</delayStart>
  <delete>false</delete>
  <hostDatacenterCode>String</hostDatacenterCode>
  <hostId>String</hostId>
  <hostLocationId>00000000-0000-0000-0000-000000000000</hostLocationId>
  <hostName>String</hostName>
  <id>00000000-0000-0000-0000-000000000000</id>
  <precedence>0</precedence>
  <scheduleId>00000000-0000-0000-0000-000000000000</scheduleId>
</ScheduledHost>

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

<ScheduledHostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result />
</ScheduledHostResponse>