Required role: | ApiUser |
All Verbs | /Light/GetLightsStatus |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrgName | query | string | No | |
AreaName | query | string | No | |
LineName | query | string | No | |
SectionName | query | string | No | |
GatewayUID | query | long | No | |
PageIndex | query | int | No | |
PageSize | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Command | form | string | No | |
Options | form | RequestOptions | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SendNoWait | form | bool | No | |
RequestTimeout | form | int | No | |
Debug | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<LightStatus> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Command | form | string | No | |
Status | form | string | No | |
ErrorMessage | form | string | No | |
ErrList | form | List<long> | No | |
DeviceList | form | List<DeviceData> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ActionName | form | string | No | |
DeviceNumber | form | string | No | |
ActionResult | form | string | No | |
ByteData | form | byte[] | No | |
ByteResult | form | byte[] | No | |
ErrorMessage | form | string | No | |
ConnectStatus | form | int | No | |
ByteDataHstr | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LightId | form | long | No | |
SampleTime | form | DateTime? | No | |
LocalTime | form | DateTime? | No | |
DimmingValue | form | double? | No | |
Voltage | form | double? | No | |
Current | form | double? | No | |
Power | form | double? | No | |
PowerFactor | form | string | No | |
ColorTemperature | form | double? | No | |
Temperature | form | double? | No | |
LuminousIntensity | form | double? | No | |
WorkingTime | form | double? | No | |
PowerConsumption | form | double? | No | |
Longitude | form | double? | No | |
Latitude | form | double? | No | |
Longitude2 | form | double? | No | |
Latitude2 | form | double? | No | |
DeviceType | form | string | No | |
PhysicalAddress | form | long | No | |
Org | form | string | No | |
Area | form | string | No | |
Line | form | string | No | |
Section | form | string | No | |
GatewayName | form | string | No | |
GatewayAddress | form | string | No | |
GatewayUID | form | long | No | |
GroupNumber | form | string | No | |
PowerModel | form | string | No | |
LightFunction | form | int | No | |
SectionId | form | long | No | |
Status | form | string | No | |
OfflineMins | form | double | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
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: 188.68.237.94
Accept: application/x-msgpack
Content-Type: application/x-msgpack
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: application/x-msgpack Content-Length: length {"Data":[{"LightId":0,"SampleTime":"0001-01-01T00:00:00.0000000+01:00","LocalTime":"0001-01-01T00:00:00.0000000+01:00","DimmingValue":0,"Voltage":0,"Current":0,"Power":0,"PowerFactor":"0.0","ColorTemperature":0,"Temperature":0,"LuminousIntensity":0,"WorkingTime":0,"PowerConsumption":0,"Longitude":0,"Latitude":0,"Longitude2":0,"Latitude2":0,"DeviceType":"String","PhysicalAddress":0,"Org":"String","Area":"String","Line":"String","Section":"String","GatewayName":"String","GatewayAddress":"String","GatewayUID":0,"GroupNumber":"String","PowerModel":"String","LightFunction":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"}]}