SSHost

<back to all web services

GatewayInspectRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/Inspectquery inspection dataquery light inspection data according to the gateway physical address list
GatewayInspectRequest Parameters:
NameParameterData TypeRequiredDescription
GatewayListqueryList<long>No
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GatewayInspectResponse Parameters:
NameParameterData TypeRequiredDescription
LightListformList<LightInspectInfo>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
LightInspectInfo Parameters:
NameParameterData TypeRequiredDescription
LightAddressformlongNo
Currentformfloat?No
Voltageformfloat?No
Powerformfloat?No
DimmingValueformint?No
DefaultDimmingValueformfloat?No
DimmingTimeformint?No
LuminousIntensityformfloat?No
PowerConsumptionformfloat?No
WorkingTimeInMinuteformfloat?No
Temperatureformfloat?No
LocalDateformDateTime?No
SampleTimeformDateTime?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 /Gateway/Inspect HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GatewayInspectRequest 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>
  <GatewayList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </GatewayList>
</GatewayInspectRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewayInspectResponse 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>
  <LightList>
    <LightInspectInfo>
      <Current>0</Current>
      <DefaultDimmingValue>0</DefaultDimmingValue>
      <DimmingTime>0</DimmingTime>
      <DimmingValue>0</DimmingValue>
      <LightAddress>0</LightAddress>
      <LocalDate>0001-01-01T00:00:00</LocalDate>
      <LuminousIntensity>0</LuminousIntensity>
      <Power>0</Power>
      <PowerConsumption>0</PowerConsumption>
      <SampleTime>0001-01-01T00:00:00</SampleTime>
      <Temperature>0</Temperature>
      <Voltage>0</Voltage>
      <WorkingTimeInMinute>0</WorkingTimeInMinute>
    </LightInspectInfo>
  </LightList>
</GatewayInspectResponse>