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

Get All Route Sets

get

/{versionId}/routeSets

Display all route sets that exist on the SDM server. You can use query parameters with this task to retrieve specific route sets. On the navigation pane, go to Get Started > Send Requests on the navigation pane. On the Send Requests page, scroll to the Pagination Parameters section for more information.

Request

Path Parameters
Query Parameters
  • Sort order shall be ascending or not. Can have values (true/false)
  • The name of the Lrt file on the device.
  • The size of the page.
  • The name of the route set.
  • The page number to be fetched.
  • Sort by specified property. Supported: name, deviceLrtFileName, deviceLrtConfigName, routeSetId, pubIdType
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 get all existing route sets using curl.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/routeSets"

The following example shows how to get all existing route sets using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/routeSets"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

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"?>
<routeSets>
  <pageInfo>
      <limitation>50</limitation>
      <numberOfElements>1</numberOfElements>
      <offset>1</offset>
  </pageInfo>
  <routeSets>
      <description>This is the test Add route through Rest API</description>
      <deviceLrtConfigName>testRoute</deviceLrtConfigName>
      <deviceLrtFilename>testRoute.xml.gz</deviceLrtFilename>
      <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
      <lastModifiedTime>2022-10-06 15:52:38</lastModifiedTime>
      <lockOwner></lockOwner>
      <lockState>false</lockState>
      <name>RouteSet1</name>
      <notes>Add route set with Import Template containing Header</notes>
      <pubIdType>E164</pubIdType>
      <routeCount>0</routeCount>
      <routeSetId>1</routeSetId>
      <version>0</version>
  </routeSets>
</routeSets>

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

{
  "pageInfo": {
    "limitation": 50,
    "numberOfElements": 3,
    "offset": 1
  },
  "routeSets": [{
      "description": "This is the test Add route through Rest API",
      "deviceLrtConfigName": "testRoute",
      "deviceLrtFilename": "testRoute.xml.gz",
      "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
      "lastModifiedTime": "2022-10-04 00:52:22",
      "lockOwner": "",
      "lockState": "false",
      "name": "RouteSet1",
      "notes": "Add route set with Import Template containing Header",
      "pubIdType": "E164",
      "routeCount": "0",
      "routeSetId": "2",
      "version": "0"
  },{
      "description": "This is the test Add route through Rest API",
      "deviceLrtConfigName": "testRoute2",
      "deviceLrtFilename": "testRoute2.xml.gz",
      "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
      "lastModifiedTime": "2022-10-04 00:54:08",
      "lockOwner": "",
      "lockState": "false",
      "name": "RouteSet2",
      "notes": "Add route set with Import Template containing Header",
      "pubIdType": "E164",
      "routeCount": "0",
      "routeSetId": "3",
      "version": "0"
  },{
      "description": "",
      "deviceLrtConfigName": "rs161",
      "deviceLrtFilename": "rs161.xml.gz",
      "deviceRequiresUpdating": "0 device(s) out of 1 need updating",
      "lastModifiedTime": "2022-09-30 01:37:06",
      "lockOwner": "admin",
      "lockState": "true",
      "name": "rs161",
      "notes": "",
      "pubIdType": "E164",
      "routeCount": "2",
      "routeSetId": "1",
      "version": "1"
  }]
}

Example for Range Type RouteSet

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

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<routeSets>
    <pageInfo>
        <limitation>50</limitation>
        <numberOfElements>1</numberOfElements>
        <offset>1</offset>
    </pageInfo>
        <routeSets>
        <description>This is the test Add route through Rest API</description>
        <deviceLrtConfigName>testRoute2</deviceLrtConfigName>
        <deviceLrtFilename>testRoute2.xml.gz</deviceLrtFilename>
        <deviceRequiresUpdating>0 device(s) out of 0 need updating</deviceRequiresUpdating>
        <lastModifiedTime>2000-12-09 07:07:31</lastModifiedTime>
        <lockOwner></lockOwner>
        <lockState>false</lockState>
        <name>test_route1</name>
        <notes>Add route set with Import Template containing Header</notes>
        <pubIdType>range</pubIdType>
        <routeCount>0</routeCount>
        <routeSetId>18</routeSetId>
        <version>0</version>
    </routeSets>
</routeSets>

An example JSON response:

{
  "pageInfo": {
    "limitation": 50,
    "numberOfElements": 2,
    "offset": 1
  },
  "routeSets": [{
     "description": "This is the test Add route through Rest API",
     "deviceLrtConfigName": "testRoute",
     "deviceLrtFilename": "testRoute.xml.gz",
     "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
     "lastModifiedTime": "2000-12-04 10:14:36",
     "lockOwner": "",
     "lockState": "false",
     "name": "RouteSet1",
     "notes": "Add route set with Import Template containing Header",
     "pubIdType": "E164",
     "routeCount": "0",
     "routeSetId": "1",
     "version": "0"
  },{
     "description": "This is the test Add route through Rest API",
     "deviceLrtConfigName": "testRoute",
     "deviceLrtFilename": "testRoute.xml.gz",
     "deviceRequiresUpdating": "0 device(s) out of 0 need updating",
     "lastModifiedTime": "2000-12-09 09:06:44",
     "lockOwner": "",
     "lockState": "false",
     "name": "TestRouteSet1",
     "notes": "Add route set with Import Template containing Header",
     "pubIdType": "range",
     "routeCount": "0",
     "routeSetId": "13",
     "version": "0"
  }]
}
Back to Top