Net3 API Interface for Customer Portal

<back to all web services

Schedule

Create and update Schedules for Cloud Valet (TM)

Requires Authentication
The following routes are available for this service:
POST/schedule
POST/schedule/{userId}
GET/schedule/hosts/{scheduleId}
Schedule Parameters:
NameParameterData TypeRequiredDescription
scheduleIdpathGuidYesThe Id of the Schedule
namebodystringNo
descriptionbodystringNo
utcOffsetbodyintNo
runDaysbodystringNo
startTimebodyTimeSpanNo
stopTimebodyTimeSpanNo
enabledbodyboolNo
snoozedbodyboolNo
runForbodyint?No
runUntilbodyDateTime?No
resumebodyDateTime?No
snoozeModebodystringNo
ScheduleBase Parameters:
NameParameterData TypeRequiredDescription
companyIdformGuidNo
userIdformGuidNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
ScheduleResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeScheduleNo
ResponseStatusformResponseStatusNo
TypeSchedule Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CompanyIdformGuidNo
NameformstringNo
DescriptionformstringNo
UTCOffsetformintNo
RunDaysformstringNo
StartTimeformTimeSpanNo
StopTimeformTimeSpanNo
EnabledformboolNo
SnoozedformboolNo
RunForformint?No
RunUntilformDateTime?No
ResumeformDateTime?No
SnoozeModeformstringNo

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 HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Schedule 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>
  <description>String</description>
  <enabled>false</enabled>
  <name>String</name>
  <resume>0001-01-01T00:00:00</resume>
  <runDays>String</runDays>
  <runFor>0</runFor>
  <runUntil>0001-01-01T00:00:00</runUntil>
  <scheduleId>00000000-0000-0000-0000-000000000000</scheduleId>
  <snoozeMode>String</snoozeMode>
  <snoozed>false</snoozed>
  <startTime>PT0S</startTime>
  <stopTime>PT0S</stopTime>
  <utcOffset>0</utcOffset>
</Schedule>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleResponse 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:_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_CompanyId_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_Enabled_x003E_k__BackingField>false</d2p1:_x003C_Enabled_x003E_k__BackingField>
    <d2p1:_x003C_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    <d2p1:_x003C_Resume_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_Resume_x003E_k__BackingField>
    <d2p1:_x003C_RunDays_x003E_k__BackingField>String</d2p1:_x003C_RunDays_x003E_k__BackingField>
    <d2p1:_x003C_RunFor_x003E_k__BackingField>0</d2p1:_x003C_RunFor_x003E_k__BackingField>
    <d2p1:_x003C_RunUntil_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_RunUntil_x003E_k__BackingField>
    <d2p1:_x003C_SnoozeMode_x003E_k__BackingField>String</d2p1:_x003C_SnoozeMode_x003E_k__BackingField>
    <d2p1:_x003C_Snoozed_x003E_k__BackingField>false</d2p1:_x003C_Snoozed_x003E_k__BackingField>
    <d2p1:_x003C_StartTime_x003E_k__BackingField>PT0S</d2p1:_x003C_StartTime_x003E_k__BackingField>
    <d2p1:_x003C_StopTime_x003E_k__BackingField>PT0S</d2p1:_x003C_StopTime_x003E_k__BackingField>
    <d2p1:_x003C_UTCOffset_x003E_k__BackingField>0</d2p1:_x003C_UTCOffset_x003E_k__BackingField>
  </Result>
</ScheduleResponse>