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 .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/GetLightsStatus HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetLightsStatusRequest 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>
  <AreaName>String</AreaName>
  <GatewayUID>0</GatewayUID>
  <LineName>String</LineName>
  <OrgName>String</OrgName>
  <PageIndex>0</PageIndex>
  <PageSize>0</PageSize>
  <SectionName>String</SectionName>
</GetLightsStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLightsStatusResponse 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:LightStatus>
      <d2p1:Area>String</d2p1:Area>
      <d2p1:ColorTemperature>0</d2p1:ColorTemperature>
      <d2p1:Current>0</d2p1:Current>
      <d2p1:DeviceType>String</d2p1:DeviceType>
      <d2p1:DimmingValue>0</d2p1:DimmingValue>
      <d2p1:GatewayAddress>String</d2p1:GatewayAddress>
      <d2p1:GatewayName>String</d2p1:GatewayName>
      <d2p1:GroupNumber>String</d2p1:GroupNumber>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Latitude2>0</d2p1:Latitude2>
      <d2p1:LightFunction>0</d2p1:LightFunction>
      <d2p1:LightId>0</d2p1:LightId>
      <d2p1:LightPhysicalAddress>String</d2p1:LightPhysicalAddress>
      <d2p1:Line>String</d2p1:Line>
      <d2p1:LocalTime>0001-01-01T00:00:00</d2p1:LocalTime>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Longitude2>0</d2p1:Longitude2>
      <d2p1:LuminousIntensity>0</d2p1:LuminousIntensity>
      <d2p1:MocNominalna>0</d2p1:MocNominalna>
      <d2p1:OfflineMins>0</d2p1:OfflineMins>
      <d2p1:Org>String</d2p1:Org>
      <d2p1:Power>0</d2p1:Power>
      <d2p1:PowerConsumption>0</d2p1:PowerConsumption>
      <d2p1:PowerFactor_NR>0</d2p1:PowerFactor_NR>
      <d2p1:PowerFreq>0</d2p1:PowerFreq>
      <d2p1:PowerModel>String</d2p1:PowerModel>
      <d2p1:SampleTime>0001-01-01T00:00:00</d2p1:SampleTime>
      <d2p1:Section>String</d2p1:Section>
      <d2p1:SectionId>0</d2p1:SectionId>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:Temperature>0</d2p1:Temperature>
      <d2p1:Version>String</d2p1:Version>
      <d2p1:Voltage>0</d2p1:Voltage>
      <d2p1:WorkingTimeMins>0</d2p1:WorkingTimeMins>
    </d2p1:LightStatus>
  </Data>
</GetLightsStatusResponse>