ERL Management

This section of API document provides all the operations that can be performed as part of ERL Management API in CER.

ERL Management

Fetch Conventional ERL

`/cerl`

GET https://{CER-IP}/cerappservices/service/cerl

The /cerl resource retrieves all the conventional ERLs currently available in CER.

Response examples

XML response

<ConventionalERLResponse>
    <status>Success</status>
    <ConventionalERLDetails>
        <ConventionalERL>
            <ERLName>Default</ERLName>
            <Description></Description>
            <TestERL>false</TestERL>
            <TimeZone></TimeZone>
            <ELINSettings/>
            <OnsiteAlertSettings>
                <OnsiteAlertID>lobby2</OnsiteAlertID>
            </OnsiteAlertSettings>
            <ALIDetails>
                <HouseNumber>3213</HouseNumber>
                <HouseNumberSuffix></HouseNumberSuffix>
                <StreetName>addsa</StreetName>
                <PrefixDirectional></PrefixDirectional>
                <StreetSuffix></StreetSuffix>
                <PostDirectional></PostDirectional>
                <CommunityName>fsda</CommunityName>
                <State>fd</State>
                <MainNPA></MainNPA>
                <CustomerName>asdsd</CustomerName>
                <COS>5</COS>
                <TOS>4</TOS>
                <Exchange></Exchange>
                <MainTelNum></MainTelNum>
                <OrderNumber></OrderNumber>
                <CountyID></CountyID>
                <CompanyID>dsads</CompanyID>
                <ZipCode></ZipCode>
                <ZipCodeExt></ZipCodeExt>
                <CustomerCode>sds</CustomerCode>
                <Comments></Comments>
                <Longitude></Longitude>
                <Latitude></Latitude>
                <Elevation></Elevation>
                <TARCode></TARCode>
                <Location></Location>
                <ProvReserved></ProvReserved>
            </ALIDetails>
            <links/>
        </ConventionalERL>
        <ConventionalERL>
            <ERLName>erl1</ERLName>
            <Description>erldef</Description>
            <TestERL>false</TestERL>
            <TimeZone></TimeZone>
            <ELINSettings>
                <ELINDetails>
                    <RoutePattern>10911</RoutePattern>
                    <ELIN>6011621123</ELIN>
                </ELINDetails>
            </ELINSettings>
            <OnsiteAlertSettings>
                <OnsiteAlertID>lobby1</OnsiteAlertID>
            </OnsiteAlertSettings>
            <ALIDetails>
                <HouseNumber>3213</HouseNumber>
                <HouseNumberSuffix></HouseNumberSuffix>
                <StreetName>addsa</StreetName>
                <PrefixDirectional></PrefixDirectional>
                <StreetSuffix></StreetSuffix>
                <PostDirectional></PostDirectional>
                <CommunityName>fsda</CommunityName>
                <State>fd</State>
                <MainNPA></MainNPA>
                <CustomerName>asdsd</CustomerName>
                <COS>5</COS>
                <TOS>4</TOS>
                <Exchange></Exchange>
                <MainTelNum></MainTelNum>
                <OrderNumber></OrderNumber>
                <CountyID></CountyID>
                <CompanyID>dsads</CompanyID>
                <ZipCode></ZipCode>
                <ZipCodeExt></ZipCodeExt>
                <CustomerCode>sds</CustomerCode>
                <Comments></Comments>
                <Longitude></Longitude>
                <Latitude></Latitude>
                <Elevation></Elevation>
                <TARCode></TARCode>
                <Location></Location>
                <ProvReserved></ProvReserved>
            </ALIDetails>
            <links>
                <publisherURL>https://unity-pri/cerappservices/service/cerl?erlName=erl1</publisherURL>
                <subscriberURL>https://cucm207/cerappservices/service/cerl?erlName=erl1</subscriberURL>
            </links>
        </ConventionalERL>
    </ConventionalERLDetails>
</ConventionalERLResponse>

JSON response

{
    "status": "Success",
    "ConventionalERLDetails": {
        "ConventionalERL": [
            {
                "ERLName": "Default",
                "Description": "",
                "TestERL": "false",
                "TimeZone": "",
                "ELINSettings": null,
                "OnsiteAlertSettings": {
                    "OnsiteAlertID": "lobby2"
                },
                "ALIDetails": {
                    "HouseNumber": "3213",
                    "HouseNumberSuffix": "",
                    "StreetName": "addsa",
                    "PrefixDirectional": "",
                    "StreetSuffix": "",
                    "PostDirectional": "",
                    "CommunityName": "fsda",
                    "State": "fd",
                    "MainNPA": "",
                    "CustomerName": "asdsd",
                    "COS": "5",
                    "TOS": "4",
                    "Exchange": "",
                    "MainTelNum": "",
                    "OrderNumber": "",
                    "CountyID": "",
                    "CompanyID": "dsads",
                    "ZipCode": "",
                    "ZipCodeExt": "",
                    "CustomerCode": "sds",
                    "Comments": "",
                    "Longitude": "",
                    "Latitude": "",
                    "Elevation": "",
                    "TARCode": "",
                    "Location": "",
                    "ProvReserved": ""
                },
                "links": null
            },
            {
                "ERLName": "erl1",
                "Description": "erldef",
                "TestERL": "false",
                "TimeZone": "",
                "ELINSettings": {
                    "ELINDetails": {
                        "RoutePattern": "10911",
                        "ELIN": "6011621123"
                    }
                },
                "OnsiteAlertSettings": {
                    "OnsiteAlertID": "lobby1"
                },
                "ALIDetails": {
                    "HouseNumber": "3213",
                    "HouseNumberSuffix": "",
                    "StreetName": "addsa",
                    "PrefixDirectional": "",
                    "StreetSuffix": "",
                    "PostDirectional": "",
                    "CommunityName": "fsda",
                    "State": "fd",
                    "MainNPA": "",
                    "CustomerName": "asdsd",
                    "COS": "5",
                    "TOS": "4",
                    "Exchange": "",
                    "MainTelNum": "",
                    "OrderNumber": "",
                    "CountyID": "",
                    "CompanyID": "dsads",
                    "ZipCode": "",
                    "ZipCodeExt": "",
                    "CustomerCode": "sds",
                    "Comments": "",
                    "Longitude": "",
                    "Latitude": "",
                    "Elevation": "",
                    "TARCode": "",
                    "Location": "",
                    "ProvReserved": ""
                },
                "links": {
                    "publisherURL": "https://unity-pri/cerappservices/service/cerl?erlName=erl1",
                    "subscriberURL": "https://cucm207/cerappservices/service/cerl?erlName=erl1"
                }
            }
        ]
    }
}

Fields	Description
status	Overall status message for the response
ERLName	Name of the conventional ERL
Description	Description of the ERL
TestERL	Flag to specify if its a test ERL
TimeZone	Timezone which the ERL belongs to
ELIN Details	ELIN Details which include RoutePattern and ELIN
ALI Details	The ALI details which includes HouseNumber, HouseNumberSuffix, StreetName, PrefixDirectional, StreetSuffix, PostDirectional, CommunityName, State, MainNPA, CustomerName, COS, TOS, Exchange, MainTelNum, OrderNumber, CountyID, CompanyID, ZipCode, ZipCodeExt, CustomerCode, Comments, Longitude, Latitude, Elevation, TARCode, Location, ProvReserved
links	publisherURL and subscriberURL are the direct urls for the conventional ERL in publisher and subscriber respectively

Fetch Class of Service

`/cerl/cos/`

GET https://{CER-IP}/cerappservices/service/cerl/cos

The /cerL/cos/ resource retrieves Class of Service currently available in CER.

Response examples

XML response

<listCOSResponse>
    <classOfService>
        <cos>ResidenceOPX</cos>
        <cos>Mobile/Wireless Phase 0</cos>
        <cos>Coin 2Way</cos>
        <cos>Coin 1W out</cos>
        <cos>Centrex</cos>
        <cos>Business PBX</cos>
        <cos>Residence PBX</cos>
        <cos>Business</cos>
        <cos>Residence</cos>
        <cos>Business OPX</cos>
    </classOfService>
</listCOSResponse>

JSON response

{
    "classOfService": {
        "cos": [
            "ResidenceOPX",
            "Mobile/Wireless Phase 0",
            "Coin 2Way",
            "Coin 1W out",
            "Centrex",
            "Business PBX",
            "Residence PBX",
            "Business",
            "Residence",
            "Business OPX"
        ]
    }
}

Fields	Description
cos	Class of service of conventional ERL in CER

Type of Service

`/cer/tos/`

GET https://{CER-IP}/cerappservices/service/cerl/tos/

The /cer/tos/ resource retrieves Type of Service currently available in CER.

Response examples

XML response

<listTOSResponse>
    <typeOfService>
        <tos>Local Ported Number (LNP)</tos>
        <tos>Non-Pub FX outside 911 area</tos>
        <tos>Non-Pub FX in 911 area</tos>
        <tos>Non-Pub</tos>
        <tos>FX outside 911 area</tos>
        <tos>FX in 911 area</tos>
        <tos>Not FX nor Non-Pub</tos>
    </typeOfService>
</listTOSResponse>

JSON response

{
    "typeOfService": {
        "tos": [
            "Local Ported Number (LNP)",
            "Non-Pub FX outside 911 area",
            "Non-Pub FX in 911 area",
            "Non-Pub",
            "FX outside 911 area",
            "FX in 911 area",
            "Not FX nor Non-Pub"
        ]
    }
}

Fields	Description
tos	Type of service of conventional ERL in CER

Fetch all Timezone

`/cer/timezone`

GET https://{CER-IP}/cerappservices/service/cerl/timezone

The /cer/timezone resource retrieves Timezone currently available in CER.

Response examples

XML response

<listTimeZoneResponse>
    <timeZones>
        <timeZone>ACT</timeZone>
        <timeZone>AET</timeZone>
        <timeZone>AGT</timeZone>
        <timeZone>ART</timeZone>
        <timeZone>AST</timeZone>
        <timeZone>Africa/Abidjan</timeZone>
        <timeZone>Africa/Accra</timeZone>
        <timeZone>Africa/Addis_Ababa</timeZone>
        <timeZone>Africa/Algiers</timeZone>
        <timeZone>Africa/Asmara</timeZone>
        <timeZone>Africa/Asmera</timeZone>
        <timeZone>Africa/Bamako</timeZone>
        <timeZone>Africa/Bangui</timeZone>
        <timeZone>Africa/Banjul</timeZone>
        <timeZone>Africa/Bissau</timeZone>
        <timeZone>Africa/Blantyre</timeZone>
        <timeZone>Africa/Brazzaville</timeZone>
        ...
        ...
        <timeZone>VST</timeZone>
        <timeZone>W-SU</timeZone>
        <timeZone>WET</timeZone>
        <timeZone>Zulu</timeZone>
    </timeZones>
</listTimeZoneResponse>

JSON response

{
    "timeZones": {
        "timeZone": [
            "ACT",
            "AET",
            "AGT",
            "ART",
            "AST",
            "Africa/Abidjan",
            "Africa/Accra",
            "Africa/Addis_Ababa",
            "Africa/Algiers",
            "Africa/Asmara",
            "Africa/Asmera",
            "Africa/Bamako",
            "Africa/Bangui",
            "Africa/Banjul",
            "Africa/Bissau",
            "Africa/Blantyre",
            "Africa/Brazzaville",
            ...
            ...
            "VST",
            "W-SU",
            "WET",
            "Zulu"
        ]
    }
}

Fields	Description
Timezone	Timezones in CER

Add New Conventional ERL

`/cerl`

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

This URL adds new Conventional ERL in CER. The request should be made using HTTP POST method with a body in below mentioned format. On successful insertion, a 200 OK response will be sent. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request examples

XML request

<insertConventionalERLRequest>
    <ConventionalERL>
        <ERLName>erl10</ERLName>
        <Description>erl10</Description>
        <TestERL>true</TestERL>
        <TimeZone>Asia/Calcutta</TimeZone>
        <ELINSettings>
            <ELINDetails>
                <RoutePattern>1091</RoutePattern>
                <ELIN>6012449001</ELIN>
            </ELINDetails>
            <ELINDetails>
                <RoutePattern>1091</RoutePattern>
                <ELIN>601244902</ELIN>
            </ELINDetails>
        </ELINSettings>
        <OnsiteAlertSettings>
            <OnsiteAlertID>OnsiteAlert</OnsiteAlertID>
        </OnsiteAlertSettings>
        <ALIDetails>
            <HouseNumber>d</HouseNumber>
            <HouseNumberSuffix></HouseNumberSuffix>
            <StreetName>d</StreetName>
            <CommunityName>d</CommunityName>
            <State>dd</State>
            <CustomerName>d</CustomerName>
            <COS>Coin 1W out</COS>
            <TOS>Not FX nor Non-Pub</TOS>
            <CompanyID>d</CompanyID>
            <CustomerCode>dqw</CustomerCode>
        </ALIDetails>
    </ConventionalERL>
</insertConventionalERLRequest>

JSON request

{
    "ConventionalERL": {
        "ERLName": "erl10",
        "Description": "erl10",
        "TestERL": "true",
        "TimeZone": "Asia/Calcutta",
        "ELINSettings": {
            "ELINDetails": [
                {
                    "RoutePattern": "1091",
                    "ELIN": "6012449001"
                },
                {
                    "RoutePattern": "1091",
                    "ELIN": "601244902"
                }
            ]
        },
        "OnsiteAlertSettings": {
            "OnsiteAlertID": "OnsiteAlert"
        },
        "ALIDetails": {
            "HouseNumber": "d",
            "HouseNumberSuffix": "",
            "StreetName": "d",
            "CommunityName": "d",
            "State": "dd",
            "CustomerName": "d",
            "COS": "Coin 1W out",
            "TOS": "Not FX nor Non-Pub",
            "CompanyID": "d",
            "CustomerCode": "dqw"
        }
    }
}

Fields	Description
ERLName	Name of the conventional ERL
Description	Description of the conventional ERL
TestERL	Flag to specify if its a test ERL
TimeZone	Timezone which the ERL belongs to
ELIN Details	ELIN Details which include RoutePattern and ELIN
OnsiteAlertID	Onsite AlertID that belongs to onsiteAlertSettings
ALI Details	The ALI details which includes HouseNumber, HouseNumberSuffix, StreetName, PrefixDirectional, StreetSuffix, PostDirectional, CommunityName, State, MainNPA, CustomerName, COS, TOS, Exchange, MainTelNum, OrderNumber, CountyID, CompanyID, ZipCode, ZipCodeExt, CustomerCode, Comments, Longitude, Latitude, Elevation, TARCode, Location, ProvReserved

Response examples

XML response

<insertConventionalERLResponse>
    <status>Success</status>
    <message>Conventional ERL 'erl11' added successfully</message>
    <links>
        <publisherURL>https://cer151/cerappservices/service/cerl?erlName=erl11</publisherURL>
        <subscriberURL>https://unity-sec/cerappservices/service/cerl?erlName=erl11</subscriberURL>
    </links>
</insertConventionalERLResponse>

JSON response

{
    "status": "Success",
    "message": "Conventional ERL 'erl12' added successfully",
    "links": {
        "publisherURL": "https://cer151/cerappservices/service/cerl?erlName=erl12",
        "subscriberURL": "https://unity-sec/cerappservices/service/cerl?erlName=erl12"
    }
}

Fields	Description
status	Overall status message for the response
message	Detailed message for the response
links	Lists direct URLs for the Conventional ERL in publisher and subscriber (publisherURL, subscriberURL)

Delete Conventional ERL

`/cerl?erlName=erl10`

DELETE https://{CER-IP}/cerappservices/service/cerl?erlName=erl10

This URL deletes an existing Conventional ERL in CER. The request should be made using HTTP DELETE method. On successful deletion, a 200 OK response will be sent in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Path parameters

Parameters	Description
erlName	Conventional ERL name as stored in CER

Response examples

XML response

<deleteConventionalERLResponse>
   <status>Success</status>
   <message>Conventional ERL 'erl10' deleted successfully</message>
</deleteConventionalERLResponse>

JSON response

{
    "status": "Success",
    "message": "Conventional ERL 'erl11' deleted successfully"
}

Fields	Description
status	Status corresponding to current ERL
message	Message related to the delete operation on the current ERL

Update Conventional ERL

`/cerl`

PUT https://{CER-IP}/cerappservices/service/cerl

This URL updates an existing Conventional ERL in CER. The request should be made using HTTP PUT method with a body in below mentioned format. On successful insertion, a 200 OK response will be sent in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request examples

XML request

<updateConventionalERLRequest>
    <ConventionalERL>
        <ERLName>erl12</ERLName>
        <Description></Description>
        <TestERL>false</TestERL>
        <TimeZone></TimeZone>
        <ELINSettings>
            <ELINDetails>
                <RoutePattern>10911.</RoutePattern>
                <ELIN>6012440005</ELIN>
            </ELINDetails>
        </ELINSettings>
        <OnsiteAlertSettings>
            <OnsiteAlertID>OnsiteAlert</OnsiteAlertID>
        </OnsiteAlertSettings>
        <ALIDetails>
            <HouseNumber>sd</HouseNumber>
            <HouseNumberSuffix>aedf</HouseNumberSuffix>
            <StreetName>d</StreetName>
            <PrefixDirectional>qe</PrefixDirectional>
            <StreetSuffix>PdK</StreetSuffix>
            <PostDirectional>ae</PostDirectional>
            <CommunityName>d</CommunityName>
            <State>dd</State>
            <MainNPA>654</MainNPA>
            <CustomerName>d</CustomerName>
            <COS>Centrex</COS>
            <TOS>FX outside 911 area</TOS>
            <Exchange>qwdq</Exchange>
            <MainTelNum>567</MainTelNum>
            <OrderNumber>qwdqwd</OrderNumber>
            <CountyID>qwdq</CountyID>
            <CompanyID>d</CompanyID>
            <ZipCode>dqwwq</ZipCode>
            <ZipCodeExt>dqwd</ZipCodeExt>
            <CustomerCode>fwe</CustomerCode>
            <Comments>dqddw</Comments>
            <Longitude>12.457</Longitude>
            <Latitude>12.31</Latitude>
            <Elevation>qdqwd</Elevation>
            <TARCode>dqwdwq</TARCode>
            <Location>qdqdwq</Location>
            <ProvReserved>dqdwqwdq</ProvReserved>
        </ALIDetails>
    </ConventionalERL>
</updateConventionalERLRequest>

JSON request

{
    "ConventionalERL": {
        "ERLName": "erl10",
        "Description": "",
        "TestERL": "false",
        "TimeZone": "",
        "ELINSettings": {
            "ELINDetails": {
                "RoutePattern": "10911.",
                "ELIN": "6012440005"
            }
        },
        "OnsiteAlertSettings": {
            "OnsiteAlertID": "OnsiteAlert"
        },
        "ALIDetails": {
            "HouseNumber": "sd",
            "HouseNumberSuffix": "aedf",
            "StreetName": "d",
            "PrefixDirectional": "qe",
            "StreetSuffix": "PdK",
            "PostDirectional": "ae",
            "CommunityName": "d",
            "State": "dd",
            "MainNPA": "654",
            "CustomerName": "d",
            "COS": "Centrex",
            "TOS": "FX outside 911 area",
            "Exchange": "qwdq",
            "MainTelNum": "567",
            "OrderNumber": "qwdqwd",
            "CountyID": "qwdq",
            "CompanyID": "d",
            "ZipCode": "dqwwq",
            "ZipCodeExt": "dqwd",
            "CustomerCode": "fwe",
            "Comments": "dqddw",
            "Longitude": "12.457",
            "Latitude": "12.31",
            "Elevation": "qdqwd",
            "TARCode": "dqwdwq",
            "Location": "qdqdwq",
            "ProvReserved": "dqdwqwdq"
        }
    }
}

Fields	Description
ERLName	Name of the conventional ERL
Description	Description of the conventional ERL
TestERL	Flag to specify if its a test ERL
TimeZone	Timezone which the ERL belongs to
ELIN Details	ELIN Details which include RoutePattern and ELIN
OnsiteAlertID	Onsite AlertID that belongs to onsiteAlertSettings
ALI Details	The ALI details which includes HouseNumber, HouseNumberSuffix, StreetName, PrefixDirectional, StreetSuffix, PostDirectional, CommunityName, State, MainNPA, CustomerName, COS, TOS, Exchange, MainTelNum, OrderNumber, CountyID, CompanyID, ZipCode, ZipCodeExt, CustomerCode, Comments, Longitude, Latitude, Elevation, TARCode, Location, ProvReserved

Response examples

XML response

<updateConventionalERLResponse>
    <status>Success</status>
    <message>ConventionalERL 'erl12' updated successfully</message>
</updateConventionalERLResponse>

JSON response

{
    "status": "Success",
    "message": "ConventionalERL 'erl10' updated successfully"
}

Fields	Description
status	Overall status message for the response
message	Detailed status message for the response

ERL Assignment

ERL assignment of Manual Configured Phone

`/manualconfigphone`

PUT https://{CER-IP}/cerappservices/service/manualconfigphone/

This URL assigns the ERL to manual configured phone availabLe in CER. The request should be made using HTTP PUT method with a body in below mentioned format. On successful insertion, a 200 OK response will be sent in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request examples

XML request

<updateManualPhoneRequest>
    <Extension>1016</Extension>
    <ERLName>erl12</ERLName>
</updateManualPhoneRequest>

JSON request

{
    "Extension": "1016",
    "ERLName": "erl02"
}

Fields	Description
Extension	Line Number for manual configured phone
ERL name	ERL name for manual configured phone

Response examples

XML response

<manualPhoneResponse>
    <status>Update_Success</status>
    <message>ERL Updated Sucessfully</message>
</manualPhoneResponse>

JSON response

{
    "status": "Update_Success",
    "message": "ERL Updated Sucessfully"
}

Fields	Description
status	It will show the status of updated ERL
message	It will will display the success or failure reason according to the status

Notes:

Make sure you have manual configure phone entry available which you want to update.
ERL should be present in CER server which you want to update.
Test ERL are not allowed to assigned.

ERL assignment of Unlocated Phone

`/unlocatedphone`

PUT http://{CER-IP}/cerappservices/service/unlocatedphone

The /unlocatedphone update the ERL of unlocated phone which is available in CER.

Request examples

XML request

<updateUnlocatedPhoneRequest>
    <PhoneMACAddress>b4-a4-e3-28-9b-64</PhoneMACAddress>
    <AssignERL>erl02</AssignERL>
</updateUnlocatedPhoneRequest>

JSON request

{
    "PhoneMACAddress": "b4-a4-e3-28-9b-64",
    "AssignERL": "erl02"
}

Fields	Description
PhoneMACAddress	Phone MAC Address present under unlocated phone
AssignERL	ERL name for unlocated phone

Response examples

XML response

<unlocatedPhoneResponse>
    <status>UpdatedSucessfully</status>
    <message>Erl assigned Sucessfully</message>
</unlocatedPhoneResponse>

JSON response

{
    "status": "UpdatedSucessfully",
    "message": "Erl assigned Sucessfully"
}

Fields	Description
status	It will show the status of updated ERL
message	It will will display the success or failure reason according to the status

Notes:

Make sure you have unlocated phone entry available which you want update it.
ERL should be present in CER server which you want to update it.
Test ERL are not allowed to assigned.

ERL assignment of Switch Ports

/switchport

PUT http://{CER-IP}/cerappservices/service/switchport/

This URL updates the ERL to crossponding switch port as available in CER. Confirm discovery is complete before invoking this API.

Request Example

XML request

<updateSwitchPortRequest>
   <IPaddress>10.77.34.224</IPaddress>
   <Allports>false</Allports>
   <ERLName>erl10</ERLName>
   <Ports>
       <PortID>0/8/12</PortID>
       <PortID>0/8/11d</PortID>
   </Ports>
</updateSwitchPortRequest>

JSON request

{
    "IPaddress": "10.77.34.224",
    "Allports": "false",
    "ERLName": "erl10",
    "Ports": [
        "0/8/12",
        "0/8/11d"
    ]
}

Fields	Description
IPaddress	IP Address of switch Port
Allports	True will apply the changes for all ports associated with this IP and false will apply the changes on specific PortID.
ERLName	ERL name for switch port
PortID	PortID of switch port

Response Example

XML response

<switchPortsResponse>
   <status>Partially failed</status>
   <message>Update of ERL to switch port Failed  for ports [0/8/11d] and Success for ports [0/8/12]    </message>
</switchPortsResponse>

JSON response

{
   "status": "Partially failed",
   "message": "Update of ERL to switch port Failed  for ports [0/8/11d] and Success for ports [0/8/12]"
}

Fields	Description
status	It will show the status of updated ERL
message	It will will display the success or failure reason according to the status

ERL assignment of IPSubnet Phones

`/ipsubnetphone`

PUT http://{CER-IP}/cerappservices/service/ipsubnetphone

This URL updates ERL to the IP subnet as available in CER.

Request Example

XML request

<updateIPSubnetPhoneRequest>
   <SUBNETID>10.107.37.111</SUBNETID>
   <SUBNETMASK>255.255.255.255</SUBNETMASK>
   <ERLNAME>erl03</ERLNAME>
</updateIPSubnetPhoneRequest>

JSON request

{
   "SUBNETID": "10.107.37.111",
   "SUBNETMASK": "255.255.255.255",
   "ERLNAME": "erl03"
}

Fields	Description
SUBNETID	Subnet ID for IPsubnet
SUBNETMASK	Subnet Mask for IPsubnet
ERLName	ERL name for IPsubnet

Response Examples

XML response

<ipSubnetPhoneResponse>
   <status>UpdateSuccess</status>
   <message>IP Subnet Phone Updated Sucessfully</message>
</ipSubnetPhoneResponse>

JSON response

{
   "status": "UpdateSuccess",
   "message": "IP Subnet Phone Updated Sucessfully"
}

Fields	Description
status	It will show the status of updated ERL
message	It will display the success or failure reason according to the status

Note: Test ERL are not allowed to be assigned.

ERL assignment of Access Points.

`/accesspoints`

PUT http://{CER-IP}/cerappservices/service/accesspoints

This URL updates ERL to the Access Point as available in CER.

Request Example

XML request

<updateAccessPointRequest>
   <Bssid>123:4:45</Bssid>
   <ErlName>erl1</ErlName>
</updateAccessPointRequest>

JSON request

{
    "Bssid": "123:4:45",
    "ErlName": "erl1"
}

Fields	Description
Bssid	BSSID of AccessPoint
ErlName	ERL name for AccessPoint

Response Example

XML response

<accessPointsResponse>
   <status>UpdatedSuccessfully</status>
   <message>Assignment of ERL to AccessPoint got Success</message>
</accessPointsResponse>

JSON response

{
   "status": "UpdatedSuccessfully",
   "message": "Assignment of ERL to AccessPoint got Success"
}

Fields	Description
status	It will show the status of updated ERL
message	It will will display the success or failure reason according to the status

Note: Test ERL are not allowed to assigned.

Fetch all Access Points

`/accesspoints`

GET http://{CER-IP}/cerappservices/service/accesspoints

The /accesspoints API resource retrieves all the Access Point available in CER.

Response Example

XML response

<AccessPointResponse>
   <status>Success</status>
   <AccessPoints>
       <AccessPoint>
           <name>cer-test</name>
           <erlName></erlName>
           <location>CER ap2</location>
           <numberOfPhones>0</numberOfPhones>
           <AccessPointPhones/>
           <links>
               <publisherURL>https://cer151/cerappservices/service/accesspoints?apname=cer-test</publisherURL>
               <subscriberURL>https://unity-sec/cerappservices/service/accesspoints?apname=cer-test</subscriberURL>
           </links>
       </AccessPoint>
       <AccessPoint>
           <name>test</name>
           <erlName></erlName>
           <location>CER ap1</location>
           <numberOfPhones>0</numberOfPhones>
           <AccessPointPhones/>
           <links>
               <publisherURL>https://cer151/cerappservices/service/accesspoints?apname=test</publisherURL>
               <subscriberURL>https://unity-sec/cerappservices/service/accesspoints?apname=test</subscriberURL>
           </links>
       </AccessPoint>
       <AccessPoint>
           <name>cer-test2</name>
           <erlName></erlName>
           <location>CER ap3</location>
           <numberOfPhones>0</numberOfPhones>
           <AccessPointPhones/>
           <links>
               <publisherURL>https://cer151/cerappservices/service/accesspoints?apname=cer-test2</publisherURL>
               <subscriberURL>https://unity-sec/cerappservices/service/accesspoints?apname=cer-test2</subscriberURL>
           </links>
       </AccessPoint>
   </AccessPoints>
</AccessPointResponse>

JSON response

{
    "status": "Success",
    "AccessPoints": [
        {
            "name": "cer-test",
            "erlName": [],
            "location": "CER ap2",
            "numberOfPhones": "0",
            "AccessPointPhones": [],
            "links": {
                "publisherURL": "https://cer151/cerappservices/service/accesspoints?apname=cer-test",
                "subscriberURL": "https://unity-sec/cerappservices/service/accesspoints?apname=cer-test"
            }
        },
        {
            "name": "test",
            "erlName": [],
            "location": "CER ap1",
            "numberOfPhones": "0",
            "AccessPointPhones": [],
            "links": {
                "publisherURL": "https://cer151/cerappservices/service/accesspoints?apname=test",
                "subscriberURL": "https://unity-sec/cerappservices/service/accesspoints?apname=test"
            }
        },
        {
            "name": "cer-test2",
            "erlName": [],
            "location": "CER ap3",
            "numberOfPhones": "0",
            "AccessPointPhones": [],
            "links": {
                "publisherURL": "https://cer151/cerappservices/service/accesspoints?apname=cer-test2",
                "subscriberURL": "https://unity-sec/cerappservices/service/accesspoints?apname=cer-test2"
            }
        }
    ]
}

Fields	Description
name	Name of the AccessPoint
bssid	Name of the associated BSSID
ERLName	Associated ERL name for AccessPoint
MACAddress	Phone Mac-Address present under Accesspoint
IPAddress	IP Address present under Accesspoint
Extension	Extension name of the phone present under Accesspoint
numberOfPhones	It will show the number of phone associated with the AccessPoint
location	Location of the AccessPoint
Type	Phone type presents under the Accesspoint

Fetch single AccessPoint

`/accesspoints?apname=cer-test`

GET http://{CER-IP}/cerappservices/service/accesspoints?apname=cer-test

The accesspoints?apname=cer-test API resource retrieves single access Point information detail available in CER.

Path parameters

Parameters	Description
apname	AccessPoint name which is available inr CER

Response Example

XML response

<AccessPointResponse>
   <status>Success</status>
   <AccessPoints>
       <AccessPoint>
           <name>cer-test</name>
           <erlName></erlName>
           <location>CER ap2</location>
           <numberOfPhones>0</numberOfPhones>
           <AccessPointPhones/>
           <links>
               <publisherURL>https://cer151/cerappservices/service/accesspoints?apname=cer-test</publisherURL>
               <subscriberURL>https://unity-sec/cerappservices/service/accesspoints?apname=cer-test</subscriberURL>
           </links>
       </AccessPoint>
   </AccessPoints>
</AccessPointResponse>

JSON response

{
    "status": "Success",
    "AccessPoints": {
        "AccessPoint": {
            "name": "cer-test",
            "erlName": [],
            "location": "CER ap2",
            "numberOfPhones": "0",
            "AccessPointPhones": [],
            "links": {
                "publisherURL": "https://cer151/cerappservices/service/accesspoints?apname=cer-test",
                "subscriberURL": "https://unity-sec/cerappservices/service/accesspoints?apname=cer-test"
            }
        }
    }
}

Fields	Description
name	Name of the associated AccessPoint
bssid	Name of the associated BSSID
ERLName	Associated ERL name for AccessPoint
MACAddress	Phone Mac-Address present under Accesspoint
IPAddress	IP Address present under Accesspoint
Extension	Extension name of the phone present under Accespoint
numberOfPhones	It will show the number of phone associated with the AccessPoint
location	Location of the AccessPoint
Type	Phone type presents under the Accesspoint

ERL Management

ERL Management

Fetch Conventional ERL

/cerl

Fetch Class of Service

/cerl/cos/

Type of Service

/cer/tos/

Fetch all Timezone

/cer/timezone

Add New Conventional ERL

/cerl

Delete Conventional ERL

/cerl?erlName=erl10

Path parameters

Update Conventional ERL

/cerl

ERL Assignment

ERL assignment of Manual Configured Phone

/manualconfigphone

ERL assignment of Unlocated Phone

/unlocatedphone

ERL assignment of Switch Ports

/switchport

ERL assignment of IPSubnet Phones

/ipsubnetphone

ERL assignment of Access Points.

/accesspoints

Fetch all Access Points

/accesspoints

Fetch single AccessPoint

/accesspoints?apname=cer-test

Path parameters

`/cerl`

`/cerl/cos/`

`/cer/tos/`

`/cer/timezone`

`/cerl`

`/cerl?erlName=erl10`

`/cerl`

`/manualconfigphone`

`/unlocatedphone`

`/switchport`

`/ipsubnetphone`

`/accesspoints`

`/accesspoints`

`/accesspoints?apname=cer-test`