SSHost

<back to all web services

GetGatewaysStatusRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/GetGatewaysStatus
GetGatewaysStatusRequest Parameters:
NameParameterData TypeRequiredDescription
OrgNamequerystringNo
AreaNamequerystringNo
GatewayTypequerystringNo
PageIndexqueryintNo
PageSizequeryintNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetGatewaysStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<GatewayStatus>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
GatewayStatus Parameters:
NameParameterData TypeRequiredDescription
GatewayIdformlongNo
GatewayNameformstringNo
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/GetGatewaysStatus HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetGatewaysStatusRequest 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>
  <GatewayType>String</GatewayType>
  <OrgName>String</OrgName>
  <PageIndex>0</PageIndex>
  <PageSize>0</PageSize>
</GetGatewaysStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetGatewaysStatusResponse 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:GatewayStatus>
      <d2p1:Area>String</d2p1:Area>
      <d2p1:Channel>String</d2p1:Channel>
      <d2p1:CityLat>0</d2p1:CityLat>
      <d2p1:CityLon>0</d2p1:CityLon>
      <d2p1:GatewayAddress>String</d2p1:GatewayAddress>
      <d2p1:GatewayTypeCode>0</d2p1:GatewayTypeCode>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:LocalDate>0001-01-01T00:00:00</d2p1:LocalDate>
      <d2p1:LocalTime>0001-01-01T00:00:00</d2p1:LocalTime>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Loop1Code>String</d2p1:Loop1Code>
      <d2p1:Loop2Code>String</d2p1:Loop2Code>
      <d2p1:Loop3Code>String</d2p1:Loop3Code>
      <d2p1:Loop4Code>String</d2p1:Loop4Code>
      <d2p1:Loop5Code>String</d2p1:Loop5Code>
      <d2p1:Loop6Code>String</d2p1:Loop6Code>
      <d2p1:LoopCheckDate>0001-01-01T00:00:00</d2p1:LoopCheckDate>
      <d2p1:LoopCheckLocalDate>0001-01-01T00:00:00</d2p1:LoopCheckLocalDate>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NetId>String</d2p1:NetId>
      <d2p1:Org>String</d2p1:Org>
      <d2p1:PlanName>String</d2p1:PlanName>
      <d2p1:SIM>String</d2p1:SIM>
      <d2p1:SampleTime>0001-01-01T00:00:00</d2p1:SampleTime>
      <d2p1:TimeZone>String</d2p1:TimeZone>
    </d2p1:GatewayStatus>
  </Data>
</GetGatewaysStatusResponse>