SSHost

<back to all web services

GetLightsStatusRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Light/GetLightsStatus
GetLightsStatusRequest Parameters:
NameParameterData TypeRequiredDescription
OrgNamequerystringNo
AreaNamequerystringNo
LineNamequerystringNo
SectionNamequerystringNo
GatewayUIDquerylongNo
PageIndexqueryintNo
PageSizequeryintNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetLightsStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<LightStatus>No
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
LightStatus Parameters:
NameParameterData TypeRequiredDescription
LightIdformlongNo
SampleTimeformDateTime?No
LocalTimeformDateTime?No
DimmingValueformdouble?No
Voltageformdouble?No
Currentformdouble?No
Powerformdouble?No
PowerFactorformstringNo
ColorTemperatureformdouble?No
Temperatureformdouble?No
WorkingTimeformdouble?No
Longitude2formdouble?No
Latitude2formdouble?No
DeviceTypeformstringNo
PhysicalAddressformlongNo
GatewayUIDformlongNo
SectionIdformlongNo
StatusformstringNo
OfflineMinsformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /Light/GetLightsStatus HTTP/1.1 
Host: 122.112.255.199 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"OrgName":"String","AreaName":"String","LineName":"String","SectionName":"String","GatewayUID":0,"PageIndex":0,"PageSize":0,"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"LightId":0,"SampleTime":"0001-01-01T00:00:00.0000000+08:00","LocalTime":"0001-01-01T00:00:00.0000000+08:00","DimmingValue":0,"Voltage":0,"Current":0,"Power":0,"PowerFactor":"0.0","ColorTemperature":0,"Temperature":0,"WorkingTime":0,"Longitude2":0,"Latitude2":0,"DeviceType":"String","PhysicalAddress":0,"GatewayUID":0,"SectionId":0,"Status":"String","OfflineMins":0}],"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"}]}