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
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo
GatewayResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<DeviceData>No

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

HTTP + JSV

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

POST /GatewayRequest HTTP/1.1 
Host: 122.112.255.199 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Server: String,
	Port: 0,
	Data: 
	[
		{
			ActionName: String,
			DeviceNumber: String,
			ActionResult: String,
			ByteData: AA==,
			ByteResult: AA==,
			ErrorMessage: String,
			ConnectStatus: 0,
			ByteDataHstr: 00
		}
	],
	RequestTimeout: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			ActionName: String,
			DeviceNumber: String,
			ActionResult: String,
			ByteData: AA==,
			ByteResult: AA==,
			ErrorMessage: String,
			ConnectStatus: 0,
			ByteDataHstr: 00
		}
	]
}