| Required role: | ApiUser |
| All Verbs | /Light/GetLightBasicInfo |
|---|
| 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<LightBasicInfo> | 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 |
|---|---|---|---|---|
| OrgId | form | long | No | |
| OrgName | form | string | No | |
| AreaId | form | long | No | |
| AreaName | form | string | No | |
| LineId | form | long | No | |
| LineName | form | string | No | |
| SectionId | form | long | No | |
| SectionName | form | string | No | |
| GatewayId | form | long | No | |
| GatewayName | form | string | No | |
| GatewayUID | form | long | No | |
| Gateway16 | form | string | No | |
| LightId | form | long | No | |
| Light10 | form | long | No | |
| Light16 | form | string | No | |
| PoleNumber | form | string | No | |
| Lon | form | double? | No | |
| Lat | form | double? | No | |
| PowerModel | form | string | No | |
| VoltageHighValue | form | double? | No | |
| VoltageLowValue | form | double? | No | |
| CurrentHighValue | form | double? | No | |
| CurrentLowValue | form | double? | No | |
| DimmingFactor | form | double? | No | |
| DefaultDimmingValue | form | double? | No | |
| PowerOnDimmingValue | form | double? | No | |
| MaxDimmingValue | form | double? | No | |
| MinDimmingValue | form | double? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Light/GetLightBasicInfo HTTP/1.1
Host: 188.68.237.94
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Command: String,
Options:
{
SendNoWait: False,
RequestTimeout: 0,
Debug: False
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Data:
[
{
OrgId: 0,
OrgName: String,
AreaId: 0,
AreaName: String,
LineId: 0,
LineName: String,
SectionId: 0,
SectionName: String,
GatewayId: 0,
GatewayName: String,
GatewayUID: 0,
Gateway16: String,
LightId: 0,
Light10: 0,
Light16: String,
PoleNumber: String,
Lon: 0,
Lat: 0,
PowerModel: String,
VoltageHighValue: 0,
VoltageLowValue: 0,
CurrentHighValue: 0,
CurrentLowValue: 0,
DimmingFactor: 0,
DefaultDimmingValue: 0,
PowerOnDimmingValue: 0,
MaxDimmingValue: 0,
MinDimmingValue: 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
}
]
}