SSHost

<back to all web services

GatewayOnlineRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/Onlinequery online devicesquery online section list
GatewayOnlineRequest Parameters:
NameParameterData TypeRequiredDescription
PortqueryintNo
GatewayIDquerylongNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GatewayOnlineResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayListformList<long>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

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /Gateway/Online HTTP/1.1 
Host: 122.112.255.199 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Port":0,"GatewayID":0,"Command":"String","Options":{"SendNoWait":false,"RequestTimeout":0,"Debug":false}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GatewayList":[0],"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"}]}