Net3 API Interface for Customer Portal

ScheduledHosts

The following routes are available for this service:
GET	/schedules/hosts/{companyId}
GET	/schedules/hosts/{companyId}/{scheduleId}

**ScheduledHosts** Parameters:
Name	Parameter	Data Type	Required	Description
scheduleId	path	Guid	No

**ScheduleBase** Parameters:
Name	Parameter	Data Type	Required	Description
companyId	form	Guid	No
userId	form	Guid	No

**DTOBase** Parameters:
Name	Parameter	Data Type	Required	Description
sessionId	form	string	No

**ScheduledHostsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	List<TypeScheduledHosts>	No
ResponseStatus	form	ResponseStatus	No

**TypeScheduledHosts** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
ScheduleId	form	Guid	No
HostId	form	string	No
HostName	form	string	No
HostDatacenterCode	form	string	No
HostLocationId	form	Guid	No
Precedence	form	int	No
DelayStart	form	int	No

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.

GET /schedules/hosts/{companyId} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml

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

<ScheduledHostsResponse 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:TypeScheduledHosts>
      <d2p1:_x003C_DelayStart_x003E_k__BackingField>0</d2p1:_x003C_DelayStart_x003E_k__BackingField>
      <d2p1:_x003C_HostDatacenterCode_x003E_k__BackingField>String</d2p1:_x003C_HostDatacenterCode_x003E_k__BackingField>
      <d2p1:_x003C_HostId_x003E_k__BackingField>String</d2p1:_x003C_HostId_x003E_k__BackingField>
      <d2p1:_x003C_HostLocationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_HostLocationId_x003E_k__BackingField>
      <d2p1:_x003C_HostName_x003E_k__BackingField>String</d2p1:_x003C_HostName_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Precedence_x003E_k__BackingField>0</d2p1:_x003C_Precedence_x003E_k__BackingField>
      <d2p1:_x003C_ScheduleId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ScheduleId_x003E_k__BackingField>
    </d2p1:TypeScheduledHosts>
  </Result>
</ScheduledHostsResponse>