1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. route sets management

Modify Route Entry by ID

put

/{versionId}/routeSets/{routeSetId}/entries/{entryId}

Modify route set entry details based on a specified ID that exists on the SDM server. Users provide the route set ID and route entry ID as part of the URI, and provide route info as part of request body to update the specified route entry details.

Request

Path Parameters
Back to Top

Response

200 Response

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to modify route entry by ID using curl.

curl -X PUT \
    -b sessionid.txt \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/entries/{entryId}"

The following example shows how to modify route entry by ID using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets/{routeSetId}/entries/{entryId}"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.put(url, headers=headers, data=data)

Example of the Request Body

The following example shows the contents of the request body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSetEntry>
  <carrierIdCode></carrierIdCode>
  <description>IamDescTypesednew</description>
  <destinationGroup>DestGr1</destinationGroup>
  <nextHop>Boston</nextHop>
  <npa>1</npa>
  <nxx>9</nxx>
  <objectId>ID2</objectId>
  <order>10</order>
  <preference></preference>
  <pubId>1207203</pubId>
  <pubIdFormula></pubIdFormula>
  <routingNum></routingNum>
  <sed>iamsed3</sed>
  <sedFormula></sedFormula>
  <trunkContext></trunkContext>
  <trunkGroup></trunkGroup>
  <user1></user1>
  <user2></user2>
  <user3></user3>
  <user4></user4>
  <user5></user5>
  <pUser1></pUser1>
  <pUser2></pUser2>
</routeSetEntry>

The following example shows the contents of the request body in JSON.

{
  "carrierIdCode": [],
  "description": "IamDescTypesednew",
  "destinationGroup": "DestGr1",
  "nextHop": "Boston",
  "npa": "1",
  "nxx": "9",
  "objectId": "ID1",
  "order": "10",
  "preference": [],
  "pubId": "1207203",
  "pubIdFormula": [],
  "routingNum": [],
  "sed": "iamsed3",
  "sedFormula": [],
  "trunkContext": [],
  "trunkGroup": [],
  "user1": [],
  "user2": [],
  "user3": [],
  "user4": [],
  "user5": [],
  "pUser1": [],
  "pUser2": []
}

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSetEntry>
  <carrierIdCode></carrierIdCode>
  <description>IamDescTypesednew</description>
  <destinationGroup>DestGr1</destinationGroup>
  <format></format>
  <nextHop>Boston</nextHop>
  <npa>1</npa>
  <nxx>9</nxx>
  <objectId>ID1</objectId>
  <order>10</order>
  <preference></preference>
  <priority></priority>
  <pubId>1207203</pubId>
  <pubIdFormula></pubIdFormula>
  <routingNum></routingNum>
  <sed>iamsed3</sed>
  <sedFormula></sedFormula>
  <trunkContext></trunkContext>
  <trunkGroup></trunkGroup>
  <user1></user1>
  <user2></user2>
  <user3></user3>
  <user4></user4>
  <user5></user5>
  <weight></weight>
  <pUser1></pUser1>
  <pUser2></pUser2>
</routeSetEntry>

The following example shows the contents of the response body in JSON.

{
  "carrierIdCode": "22",
  "description": "IamDescTypesednew",
  "destinationGroup": "DestGr1",
  "format": "",
  "nextHop": "Boston",
  "npa": "1",
  "nxx": "9",
  "objectId": "ID1",
  "order": "10",
  "pUser1": "admin",
  "pUser2": "admin1",
  "priority": "",
  "pubId": "1207203",
  "pubIdFormula": "",
  "routingNum": "33",
  "sed": "iamsed3",
  "sedFormula": "",
  "trunkContext": "xxx",
  "trunkGroup": "xxx",
  "user1": "u1",
  "user2": "xxx",
  "user3": "xxx",
  "user4": "xxx",
  "user5": "xxx",
  "weight": ""
}

Example for Range Type RouteSet

This example shows the response available in NNC 9.0.2 and later.

An example XML request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSetEntry>
  <carrierIdCode>22</carrierIdCode>
  <description>LastnonEmptyDescEntered</description>
  <destinationGroup>xxx</destinationGroup>
  <format></format>
  <nextHop>xxx</nextHop>
  <objectId>ID3</objectId>
  <priority></priority>
  <rangeEnd>115</rangeEnd>
  <rangeStart>100</rangeStart>
  <routingNum>33</routingNum>
  <sed>abcde</sed>
  <sedFormula></sedFormula>
  <trunkContext>xxx</trunkContext>
  <trunkGroup>xxx</trunkGroup>
  <user1>u1</user1>
  <user2>xxx</user2>
  <user3>xxx</user3>
  <user4>xxx</user4>
  <user5>xxx</user5>
  <weight></weight>
</routeSetEntry>

An example JSON request body:

{
  "description": "I am the new description",
  "destinationGroup": "DestGr1",
  "nextHop": "Boston",
  "objectId": "ID1",
  "order": "10",
  "rangeStart": "123589",
  "rangeEnd": "231777",
  "sed": "iamsed2"
}

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSetEntry>
  <carrierIdCode>22</carrierIdCode>
  <description>LastnonEmptyDescEntered</description>
  <destinationGroup>xxx</destinationGroup>
  <format></format>
  <nextHop>xxx</nextHop>
  <objectId>ID3</objectId>
  <priority></priority>
  <rangeEnd>115</rangeEnd>
  <rangeStart>100</rangeStart>
  <routingNum>33</routingNum>
  <sed>abcde</sed>
  <sedFormula></sedFormula>
  <trunkContext>xxx</trunkContext>
  <trunkGroup>xxx</trunkGroup>
  <user1>u1</user1>
  <user2>xxx</user2>
  <user3>xxx</user3>
  <user4>xxx</user4>
  <user5>xxx</user5>
  <weight></weight>
</routeSetEntry>

An example JSON response:

{
  "carrierIdCode": "",
  "description": "I am the new description",
  "destinationGroup": "DestGr1",
  "format": "",
  "nextHop": "Boston",
  "objectId": "ID1",
  "order": "10",
  "preference": "",
  "priority": "",
  "rangeEnd": "231777",
  "rangeStart": "123589",
  "routingNum": "",
  "sed": "iamsed2",
  "sedFormula": "",
  "trunkContext": "",
  "trunkGroup": "",
  "user1": "",
  "user2": "",
  "user3": "",
  "user4": "",
  "user5": "",
  "weight": ""
}
Back to Top