SSHost

GetLightBasicInfoRequest

**Requires Authentication**
Required role:	ApiUser

The following routes are available for this service:
All Verbs	/Light/GetLightBasicInfo

**IBaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Command	form	string	No
Options	form	RequestOptions	No

**RequestOptions** Parameters:
Name	Parameter	Data Type	Required
SendNoWait	form	bool	No
RequestTimeout	form	int	No
Debug	form	bool	No

**GetLightBasicInfoResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<LightBasicInfo>	No

**IBaseResult** Parameters:
Name	Parameter	Data Type	Required
Command	form	string	No
Status	form	string	No
ErrorMessage	form	string	No
ErrList	form	List<long>	No
DeviceList	form	List<DeviceData>	No

**DeviceData** Parameters:
Name	Parameter	Data Type	Required
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

**LightBasicInfo** Parameters:
Name	Parameter	Data Type	Required
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 .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 /Light/GetLightBasicInfo HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetLightBasicInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <Options>
    <Debug>false</Debug>
    <RequestTimeout>0</RequestTimeout>
    <SendNoWait>false</SendNoWait>
  </Options>
</GetLightBasicInfoRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLightBasicInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.Models">
    <d2p1:DeviceData>
      <d2p1:ActionName>String</d2p1:ActionName>
      <d2p1:ActionResult>String</d2p1:ActionResult>
      <d2p1:ByteData>AA==</d2p1:ByteData>
      <d2p1:ByteResult>AA==</d2p1:ByteResult>
      <d2p1:ConnectStatus>0</d2p1:ConnectStatus>
      <d2p1:DeviceNumber>String</d2p1:DeviceNumber>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
    </d2p1:DeviceData>
  </DeviceList>
  <ErrList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ErrList>
  <ErrorMessage>String</ErrorMessage>
  <Status>String</Status>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.SqlModels">
    <d2p1:LightBasicInfo>
      <d2p1:AreaId>0</d2p1:AreaId>
      <d2p1:AreaName>String</d2p1:AreaName>
      <d2p1:CurrentHighValue>0</d2p1:CurrentHighValue>
      <d2p1:CurrentLowValue>0</d2p1:CurrentLowValue>
      <d2p1:DefaultDimmingValue>0</d2p1:DefaultDimmingValue>
      <d2p1:DimmingFactor>0</d2p1:DimmingFactor>
      <d2p1:Gateway16>String</d2p1:Gateway16>
      <d2p1:GatewayId>0</d2p1:GatewayId>
      <d2p1:GatewayName>String</d2p1:GatewayName>
      <d2p1:GatewayUID>0</d2p1:GatewayUID>
      <d2p1:Lat>0</d2p1:Lat>
      <d2p1:Light10>0</d2p1:Light10>
      <d2p1:Light16>String</d2p1:Light16>
      <d2p1:LightId>0</d2p1:LightId>
      <d2p1:LineId>0</d2p1:LineId>
      <d2p1:LineName>String</d2p1:LineName>
      <d2p1:Lon>0</d2p1:Lon>
      <d2p1:MaxDimmingValue>0</d2p1:MaxDimmingValue>
      <d2p1:MinDimmingValue>0</d2p1:MinDimmingValue>
      <d2p1:OrgId>0</d2p1:OrgId>
      <d2p1:OrgName>String</d2p1:OrgName>
      <d2p1:PoleNumber>String</d2p1:PoleNumber>
      <d2p1:PowerModel>String</d2p1:PowerModel>
      <d2p1:PowerOnDimmingValue>0</d2p1:PowerOnDimmingValue>
      <d2p1:SectionId>0</d2p1:SectionId>
      <d2p1:SectionName>String</d2p1:SectionName>
      <d2p1:VoltageHighValue>0</d2p1:VoltageHighValue>
      <d2p1:VoltageLowValue>0</d2p1:VoltageLowValue>
    </d2p1:LightBasicInfo>
  </Data>
</GetLightBasicInfoResponse>