SSHost

<back to all web services

GetGatewayRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/GetGateway
All Verbs/Gateway/GetStatus
GetGatewayRequest Parameters:
NameParameterData TypeRequiredDescription
Gateway_IDqueryList<long>No
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetGatewayResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayListformList<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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetGateway HTTP/1.1 
Host: 188.68.237.94 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"Gateway_ID":[0],"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"GatewayList":[{"GatewayId":0,"GatewayName":"String","SampleTime":"0001-01-01T00:00:00.0000000+01:00"}],"Command":"String","Status":"String","ErrorMessage":"String","ErrList":[0],"DeviceList":[{"ActionName":"String","DeviceNumber":"String","ActionResult":"String","ByteData":"AA==","ByteResult":"AA==","ErrorMessage":"String","ConnectStatus":0,"ByteDataHstr":"00"}]}