SSHost

<back to all web services

GatewaySyncTimePlanRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/SyncTimePlan
GatewaySyncTimePlanRequest Parameters:
NameParameterData TypeRequiredDescription
GatewayListqueryList<GatewayTimePlan>No
AddOneHourqueryintNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GatewayTimePlan Parameters:
NameParameterData TypeRequiredDescription
GatewayIdformlongNo
ItemListformList<TimeDimming24H>No
AutoQuery_LightIdList_FromDatabaseformboolNo
PackDaysformintNo
TimeDimming24H Parameters:
NameParameterData TypeRequiredDescription
IndexformintNo
Scheme_IDformlongNo
SunRiseSet_IDformintNo
AstroDTformDateTimeNo
ServerDTformDateTimeNo
ItemCountformintNo
TimeStringformstringNo
MonthformintNo
DayformintNo
HourformintNo
MinuteformintNo
ModeformintNo
Param1formstringNo
Param2formstringNo
ErrorMessageformstringNo
IsHolidayformintNo
IsDayLightformintNo
AstroDateTimeStringformstringNo
ParamsStringformstringNo
IBaseResult Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
StatusformstringNo
ErrorMessageformstringNo
ErrListformList<long>No
DeviceListformList<DeviceData>No
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo

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 /Gateway/SyncTimePlan HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GatewaySyncTimePlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <Options>
    <Debug>false</Debug>
    <RequestTimeout>0</RequestTimeout>
    <SendNoWait>false</SendNoWait>
  </Options>
  <AddOneHour>0</AddOneHour>
  <GatewayList>
    <GatewayTimePlan>
      <AutoQuery_LightIdList_FromDatabase>false</AutoQuery_LightIdList_FromDatabase>
      <GatewayId>0</GatewayId>
      <ItemList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Led.GatewayCmdWrapper">
        <d4p1:TimeDimming24H>
          <d4p1:AstroDT>0001-01-01T00:00:00</d4p1:AstroDT>
          <d4p1:Day>0</d4p1:Day>
          <d4p1:ErrorMessage>String</d4p1:ErrorMessage>
          <d4p1:Hour>0</d4p1:Hour>
          <d4p1:Index>0</d4p1:Index>
          <d4p1:IsDayLight>0</d4p1:IsDayLight>
          <d4p1:IsHoliday>0</d4p1:IsHoliday>
          <d4p1:ItemCount>0</d4p1:ItemCount>
          <d4p1:Minute>0</d4p1:Minute>
          <d4p1:Mode>0</d4p1:Mode>
          <d4p1:Month>0</d4p1:Month>
          <d4p1:Param1>String</d4p1:Param1>
          <d4p1:Param2>String</d4p1:Param2>
          <d4p1:Scheme_ID>0</d4p1:Scheme_ID>
          <d4p1:ServerDT>0001-01-01T00:00:00</d4p1:ServerDT>
          <d4p1:SunRiseSet_ID>0</d4p1:SunRiseSet_ID>
          <d4p1:TimeString>String</d4p1:TimeString>
        </d4p1:TimeDimming24H>
      </ItemList>
      <PackDays>0</PackDays>
    </GatewayTimePlan>
  </GatewayList>
</GatewaySyncTimePlanRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewaySyncTimePlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.Models">
    <d2p1:DeviceData>
      <d2p1:ActionName>String</d2p1:ActionName>
      <d2p1:ActionResult>String</d2p1:ActionResult>
      <d2p1:ByteData>AA==</d2p1:ByteData>
      <d2p1:ByteResult>AA==</d2p1:ByteResult>
      <d2p1:ConnectStatus>0</d2p1:ConnectStatus>
      <d2p1:DeviceNumber>String</d2p1:DeviceNumber>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
    </d2p1:DeviceData>
  </DeviceList>
  <ErrList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ErrList>
  <ErrorMessage>String</ErrorMessage>
  <Status>String</Status>
</GatewaySyncTimePlanResponse>