Get All or subset of route entries from a perticular routeset
get
/rest/{versionId}/routeSets/{routeSetId}/entries
Use this (GET) method to display all/subset of route sets entries that exist on the SDM server. You can use query parameters with this task to retrieve specific route set entries. User can provide filtercriteria as part of method body to get subset of routes matching criteria. 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
-
routeSetId: string
The route set id whose route entries needs to be fetched.
-
versionId: string
The rest api version, it's value is v1.3.
Query Parameters
-
ascending(optional): string
The order defines whether it should be ascending order or not.
-
filterCriteria(optional): string
The filter criteria is used to filter the routes based on matching criteria.
-
limitation(optional): string
The page size repesents how many elements in each page.
-
offset(optional): string
The page number which needs ot be fetched.
Response
Supported Media Types
- application/xml
- application/json
200 Response
successful operation
Nested Schema : routeSetEntry
Type:
Show Source
object
-
carrierIdCode(optional):
string
-
destinationGroup(optional):
string
-
getpUser1(optional):
string
-
getpUser2(optional):
string
-
nextHop(optional):
string
-
npa(optional):
string
-
nxx(optional):
string
-
objectId(optional):
string
-
order(optional):
string
-
preference(optional):
string
-
pubId(optional):
string
-
pubIdFormula(optional):
string
-
routingNum(optional):
string
-
sed(optional):
string
-
sedFormula(optional):
string
-
trunkContext(optional):
string
-
trunkGroup(optional):
string
-
user1(optional):
string
-
user2(optional):
string
-
user3(optional):
string
-
user4(optional):
string
-
user5(optional):
string
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