Add gateway

The add gateway API allows the client application to create a remote gateway in IMPACT. The newly created gateway is added to an existing IMPACT group.

Add gateway describes the API structure for the creating a remote gateway in IMPACT.

Table 1. Add gateway
Title Create gateway
URL http://<Impact_URL>/impact/m2m/gateway
Method POST
Content-Type application/json
URL Params The following are the URL parameters:
  • identifier:[string]: This is an optional parameter. It specifies the name used for identifying the gateway.

  • serialNumber:[string]: This is a mandatory parameter. This parameter takes the IMEI of the gateway.

  • address:[string]: This is an optional parameter. It specifies the MSISDN associated with the gateway.

  • groupName:[string]: This is a mandatory parameter. It specifies the name of the IMACT group name in which gateway is created.

Data Params

msg:[string]: info/warning/error message

Success Code
Response Code: 200
Error Code
400 : Bad Request 
401 : Unauthorized 
404 : Not Found 
Sample Call Curl:
curl -X POST --header 'Content-Type: application/json' --header 'Accept:
            application/json'  --header 'Authorization: Basic
          ZG9jdXNlcjpBc2RmMSM=' -d ' {"identifier":"IN_KAR_BLR_001","serialNumber":"928346923642774","address":"91912345678","groupName":"DM.TEST "}''http://<impact_url>/impact/m2m/gateway
Response Body:
{
"msg": "Gateway added successfully", "Code":3000
}
Notes The group name passed through the groupName parameter must match with the group name available in IMPACT. User must have access to the group and sub-groups for creating a gateway.