SSHost

<back to all web services

GatewaySyncLightsRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/SyncLights
GatewaySyncLightsRequest Parameters:
NameParameterData TypeRequiredDescription
GatewayListqueryList<GatewayLights>No
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GatewayLights Parameters:
NameParameterData TypeRequiredDescription
GatewayIdformlongNo
LightIdListformList<long>No
AutoQuery_LightIdList_FromDatabaseformboolNo
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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

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

POST /Gateway/SyncLights HTTP/1.1 
Host: 188.68.237.94 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"GatewayList":[{"GatewayId":0,"LightIdList":[0],"AutoQuery_LightIdList_FromDatabase":false}],"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"Command":"String","Status":"String","ErrorMessage":"String","ErrList":[0],"DeviceList":[{"ActionName":"String","DeviceNumber":"String","ActionResult":"String","ByteData":"AA==","ByteResult":"AA==","ErrorMessage":"String","ConnectStatus":0,"ByteDataHstr":"00"}]}