SSHost

<back to all web services

LightStatusRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/GetLightStatus
LightStatusRequest Parameters:
NameParameterData TypeRequiredDescription
TunnelquerystringNo
DirquerystringNo
CategoryquerystringNo
LightStatusResponse Parameters:
NameParameterData TypeRequiredDescription
SectionIdformintNo
StatusformstringNo
CountformintNo
DimmingValueformstringNo
TotalformintNo
MessageformstringNo

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 /GetLightStatus HTTP/1.1 
Host: 188.68.237.94 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"Tunnel":"String","Dir":"String","Category":"String"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"SectionId":0,"Status":"String","Count":0,"DimmingValue":"String","Total":0,"Message":"String"}