| Required role: | ApiUser |
| All Verbs | /Gateway/AddGatewayOrMeter |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrgName | query | string | No | |
| AreaName | query | string | No | |
| GatewayType | query | string | No | |
| GatewayUID | query | long | No | |
| GatewayName | query | string | No | |
| PlanName | query | string | No | |
| Longitude | query | double? | No | |
| Latitude | query | double? | No | |
| SIM | query | string | No | |
| AddMeter | query | bool | No | |
| SectionName | query | string | No | |
| MeterAddress10 | query | long | No | |
| MeterName | query | string | No | |
| ProtocolCode | query | string | No | |
| CommunicationSpeed | query | string | No | |
| SamplingPeriod | query | string | No | |
| IMEI | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Command | form | string | No | |
| Options | form | RequestOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SendNoWait | form | bool | No | |
| RequestTimeout | form | int | No | |
| Debug | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddGatewayResult | form | bool | No | |
| GatewayId | form | long | No | |
| AddGatewayErrorMessage | form | string | No | |
| AddMeterResult | form | bool | No | |
| MeterId | form | long | No | |
| AddMeterErrorMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Command | form | string | No | |
| Status | form | string | No | |
| ErrorMessage | form | string | No | |
| ErrList | form | List<long> | No | |
| DeviceList | form | List<DeviceData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActionName | form | string | No | |
| DeviceNumber | form | string | No | |
| ActionResult | form | string | No | |
| ByteData | form | byte[] | No | |
| ByteResult | form | byte[] | No | |
| ErrorMessage | form | string | No | |
| ConnectStatus | form | int | No | |
| ByteDataHstr | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}