Cisco Emergency Responder Configuration API

IP Subnet Management

Operations to add/modify/delete IP Subnet configurations.

Add New IP Subnet

/ipsubnetphone

http
CopyPOST https://{CER-IP}/cerappservices/service/ipsubnetphone

Add a new IP Subnet in CER. The request should be made using the POST method with a body formatted as below. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request examples

xml
json
Copy<addIPSubnetPhoneRequest>
       <SUBNETID>34.45.35.45</SUBNETID>
       <SUBNETMASK>255.255.255.0</SUBNETMASK>
       <ERLNAME>erl2</ERLNAME>
       <LOCATION>Nashik</LOCATION>
       <DONOTTRACK>false</DONOTTRACK>
</addIPSubnetPhoneRequest>

Copy{
    "SUBNETID": "34.45.35.45",
    "SUBNETMASK": "255.255.255.0",
    "ERLNAME": "erl2",
    "LOCATION": "Nashik",
    "DONOTTRACK": false
}
Fields Description
Subnet ID IP Address of the subnet
Subnet Mask Mask of the subnet
ERL Name ERL to assign to the IP subnet
Do not track phones under this IP subnet If checked, do not track the IPSubnet and the underlying phones in CER
Location (Optional) Location of the new IP Subnet

Response examples

xml
json
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ipSubnetPhoneResponse>
                     <status>SUCCESS</status>
                     <message>IpSubnet Data Added Successfully</message>
</ipSubnetPhoneResponse>

Copy{
    "status": "SUCCESS",
    "message": "IpSubnet Data Added Successfully"
}
Fields Description
status Overall status message for the response
message Detailed message for the response

Delete IP Subnet

/ipsubnetphone

http
CopyDELETE https://{CER-IP}/cerappservices/service/ipsubnetphone

Delete an IP Subnet in CER. The request should be made using the DELETE method with a body formatted as below. On successful deletion, a 200 OK response will be sent along with appropriate status message for the respective cluster. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request example

xml
json
Copy<deleteIPSubnetRequest>
<ipsubnet>10.17.36.20</ipsubnet>
</deleteIPSubnetRequest>

Copy{
    "ipsubnet":"10.17.36.20"
}
Fields Description
ipsubnet IP subnet address to be deleted

Response examples

xml
json
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deleteIPSubnetResponse>
<status>SUCCESS</status>
     <message>IpSubnet Data Deleted Successfully</message>
 </deleteIPSubnetResponse>

Copy{
    "status": "SUCCESS",
    "message": "IpSubnet Data Deleted Successfully"
}
Fields Description
status Overall status message for the response
message Message related to the delete operation on IP Subnet

Update IP Subnet

/ipsubnetphone/update

http
CopyPUT https://{CER-IP}/cerappservices/service//ipsubnetphone/update

Update an existing IP Subnet in CER. The request should be made using the PUT method with a body formatted as below. On successful update, a 200 OK response will be sent in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request examples

xml
json
Copy<updateIPSubnetPhoneRequest>
       <SUBNETID>10.17.36.20</SUBNETID>
       <ERLNAME>Default</ERLNAME>
       <LOCATION>Delhi </LOCATION>
       <DONOTTRACK>false</DONOTTRACK>
</updateIPSubnetPhoneRequest>

Copy{
    "SUBNETID": "10.17.36.20",
    "ERLNAME": "Default",
    "LOCATION": "Delhi ",
    "DONOTTRACK": false
}
Fields Description
Subnet ID IP Address of the subnet
ERL Name ERL to assign to the IP subnet
Do not track phones under this IP subnet If checked, do not track the IPSubnet and the underlying phones in CER
Location (Optional) Location of the new IP Subnet

Response examples

xml
JSON
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<updateipSubnetPhoneResponse>
       <status>FAILED</status>
      <message>Default ERL cannot be assigned for IPSubnet</message>
</updateipSubnetPhoneResponse>

Copy{
    "status": "FAILED",
    "message": "Default ERL cannot be assigned for IPSubnet"
}
Fields Description
status Overall status message for the response
message Detailed status message for the response
Next