SSHost

<back to all web services

GatewayRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/GatewayRequest
GatewayRequest Parameters:
NameParameterData TypeRequiredDescription
ServerquerystringNo
PortqueryintNo
DataqueryList<DeviceData>No
RequestTimeoutqueryintNo
SendNoWaitqueryboolNo
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo
GatewayResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<DeviceData>No
MessageformstringNo

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

<GatewayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Data 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>
  </Data>
  <Port>0</Port>
  <RequestTimeout>0</RequestTimeout>
  <SendNoWait>false</SendNoWait>
  <Server>String</Server>
</GatewayRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Data 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>
  </Data>
  <Message>String</Message>
</GatewayResponse>