IP Subnet Management

This section of API document provides all the operations that can be performed as part of IP Subnet management API in CER.

Add New IP Subnet

/ipsubnetphone

POST https://{CER-IP}/cerappservices/service/ipsubnetphone

Add a new IPv4 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 example

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

{
    "SUBNETID": "34.45.35.45",
    "SUBNETMASK": "255.255.255.0",
    "ERLNAME": "erl2",
    "LOCATION": "Nashik",
    "DONOTTRACK": false
}

Response example

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

{
    "status": "SUCCESS",
    "message": "IpSubnet Data Added Successfully"
}

Add New IPv6 Subnet

v1/ipsubnetv6

POST https://{CER-IP}/cerappservices/service/v1/ipsubnetv6

Add a new IPv6 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 example

<InsertIpSubnetV6Request>
       <subnetID>2001:0db8:85a3:0000:0000:8a2e:0370:700</subnetID>
       <prefix>23</prefix>
       <erlName>erl1</erlName>
       <location>loc3</location>
       <doNotTrack>false</doNotTrack>
</InsertIpSubnetV6Request>

Request Header

Request Body

Response example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InsertIpSubnetV6Response>
       <message>IpSubnet Data Added Successfully</message>
       <TrackingID>CERAPP_febf161c-51b8-49db-9ae4-5815a62a6374</TrackingID>
</InsertIpSubnetV6Response>

Delete IP Subnet

/ipsubnetphone

DELETE 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

<deleteIPSubnetRequest>
<ipsubnet>10.17.36.20</ipsubnet>
</deleteIPSubnetRequest>

{
    "ipsubnet":"10.17.36.20"
}

Response example

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

{
    "status": "SUCCESS",
    "message": "IpSubnet Data Deleted Successfully"
}

Update IP Subnet

/ipsubnetphone/update

PUT 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 example

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

{
    "SUBNETID": "10.17.36.20",
    "ERLNAME": "Default",
    "LOCATION": "Delhi ",
    "DONOTTRACK": false
}

Response example

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

{
    "status": "FAILED",
    "message": "Default ERL cannot be assigned for IPSubnet"
}

Fetch IP Subnet

v1/ipsubnet

GET https://{CER-IP}/cerappservices/service/v1/ipsubnet

Retrieve the IP Subnet in CER. The request should be made using the GET method. 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.

Response example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IpSubnetDetailsResponse>
    <subnetDetails>
        <ipv4Subnets>
            <subnet>
                <subnetID>10.61.99.223</subnetID>
                <subnetMask>255.255.255.255</subnetMask>
                <erlName>erl1</erlName>
                <location>loc1</location>
                <isnontrackable>false</isnontrackable>
                <phones>
                    <phone>
                        <phoneMACAddress>74-e5-f9-e7-6e-4f</phoneMACAddress>
                        <phoneIpv4Address>10.61.99.223 </phoneIpv4Address>
                        <phoneIpv6Address>None</phoneIpv6Address>
                        <phoneExt>1000</phoneExt>
                        <phoneType>Cisco IP Communicator </phoneType>
                    </phone>
                </phones>
            </subnet>
            <subnet>
                <subnetID>10.110.220.182</subnetID>
                <subnetMask>255.255.255.255</subnetMask>
                <erlName>offERL</erlName>
                <location></location>
                <isnontrackable>false</isnontrackable>
            </subnet>
        </ipv4Subnets>
        <ipv6Subnets>
            <subnet>
                <subnetID>2001:0:130f:0:0:9c0:876a:130b</subnetID>
                <prefix>128</prefix>
                <erlName>erl1</erlName>
                <location>loc2</location>
                <isnontrackable>false</isnontrackable>
            </subnet>
        </ipv6Subnets>
    </subnetDetails>
    <paging>
        <offset>0</offset>
        <limit>500</limit>
        <count>3</count>
    </paging>
    <TrackingID>CERAPP_ab3e6aa3-e7ca-4119-90ad-8651476593fe</TrackingID>
</IpSubnetDetailsResponse>

Request URI Param

Request Header