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

<LightStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Category>String</Category>
  <Dir>String</Dir>
  <Tunnel>String</Tunnel>
</LightStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LightStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Count>0</Count>
  <DimmingValue>String</DimmingValue>
  <Message>String</Message>
  <SectionId>0</SectionId>
  <Status>String</Status>
  <Total>0</Total>
</LightStatusResponse>