SSHost

<back to all web services

GetLightBasicInfoRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Light/GetLightBasicInfo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetLightBasicInfoResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<LightBasicInfo>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
LightBasicInfo Parameters:
NameParameterData TypeRequiredDescription
OrgIdformlongNo
OrgNameformstringNo
AreaIdformlongNo
AreaNameformstringNo
LineIdformlongNo
LineNameformstringNo
SectionIdformlongNo
SectionNameformstringNo
GatewayIdformlongNo
GatewayNameformstringNo
GatewayUIDformlongNo
Gateway16formstringNo
LightIdformlongNo
Light10formlongNo
Light16formstringNo
PoleNumberformstringNo
Lonformdouble?No
Latformdouble?No
PowerModelformstringNo
VoltageHighValueformdouble?No
VoltageLowValueformdouble?No
CurrentHighValueformdouble?No
CurrentLowValueformdouble?No
DimmingFactorformdouble?No
DefaultDimmingValueformdouble?No
PowerOnDimmingValueformdouble?No
MaxDimmingValueformdouble?No
MinDimmingValueformdouble?No

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

{"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}]}