SSHost

<back to all web services

AddGatewayOrMeterRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/AddGatewayOrMeter
AddGatewayOrMeterRequest Parameters:
NameParameterData TypeRequiredDescription
OrgNamequerystringNo
AreaNamequerystringNo
GatewayTypequerystringNo
GatewayUIDquerylongNo
GatewayNamequerystringNo
PlanNamequerystringNo
Longitudequerydouble?No
Latitudequerydouble?No
SIMquerystringNo
AddMeterqueryboolNo
SectionNamequerystringNo
MeterAddress10querylongNo
MeterNamequerystringNo
ProtocolCodequerystringNo
CommunicationSpeedquerystringNo
SamplingPeriodquerystringNo
IMEIquerystringNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
AddGatewayOrMeterResponse Parameters:
NameParameterData TypeRequiredDescription
AddGatewayResultformboolNo
GatewayIdformlongNo
AddGatewayErrorMessageformstringNo
AddMeterResultformboolNo
MeterIdformlongNo
AddMeterErrorMessageformstringNo
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 .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 /Gateway/AddGatewayOrMeter HTTP/1.1 
Host: 188.68.237.94 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OrgName: String,
	AreaName: String,
	GatewayType: String,
	GatewayUID: 0,
	GatewayName: String,
	PlanName: String,
	Longitude: 0,
	Latitude: 0,
	SIM: String,
	AddMeter: False,
	SectionName: String,
	MeterAddress10: 0,
	MeterName: String,
	ProtocolCode: String,
	CommunicationSpeed: String,
	SamplingPeriod: String,
	IMEI: String,
	Command: String,
	Options: 
	{
		SendNoWait: False,
		RequestTimeout: 0,
		Debug: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AddGatewayResult: False,
	GatewayId: 0,
	AddGatewayErrorMessage: String,
	AddMeterResult: False,
	MeterId: 0,
	AddMeterErrorMessage: String,
	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
		}
	]
}