Jump to

• Request
• Response

Add a route to routeSet.

post

/rest/{versionId}/routeSets/{routeSetId}/entries

Use this (POST) add new entry to a specified routeset on SDM server. User has to provide route set Id as part of URI and route data as part of method body.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• routeSetId: string
  The route set id to which route needs to be added.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The route data to be added for a route set.

Root Schema : routeSetEntry

Type: object

Show Source

• 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

{
    "properties":{
        "carrierIdCode":{
            "type":"string"
        },
        "destinationGroup":{
            "type":"string"
        },
        "getpUser1":{
            "type":"string"
        },
        "getpUser2":{
            "type":"string"
        },
        "nextHop":{
            "type":"string"
        },
        "npa":{
            "type":"string"
        },
        "nxx":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "order":{
            "type":"string"
        },
        "preference":{
            "type":"string"
        },
        "pubId":{
            "type":"string"
        },
        "pubIdFormula":{
            "type":"string"
        },
        "routingNum":{
            "type":"string"
        },
        "sed":{
            "type":"string"
        },
        "sedFormula":{
            "type":"string"
        },
        "trunkContext":{
            "type":"string"
        },
        "trunkGroup":{
            "type":"string"
        },
        "user1":{
            "type":"string"
        },
        "user2":{
            "type":"string"
        },
        "user3":{
            "type":"string"
        },
        "user4":{
            "type":"string"
        },
        "user5":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSetEntry"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : routeSetEntries

Type: object

Show Source

• pageInfo(optional): object PageInfo
• routeSetEntries(optional): array routeSetEntry

{
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "routeSetEntries":{
            "items":{
                "$ref":"#/definitions/RestRouteSetEntry",
                "xml":{
                    "name":"routeSetEntry"
                }
            },
            "type":"array",
            "xml":{
                "name":"routeSetEntry"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSetEntries"
    }
}

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "properties":{
        "limitation":{
            "format":"int32",
            "type":"integer"
        },
        "numberOfElements":{
            "format":"int64",
            "type":"integer"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : routeSetEntry

Type: array

Show Source

• Array of: object routeSetEntry

{
    "items":{
        "$ref":"#/definitions/RestRouteSetEntry",
        "xml":{
            "name":"routeSetEntry"
        }
    },
    "type":"array",
    "xml":{
        "name":"routeSetEntry"
    }
}

Nested Schema : routeSetEntry

Type: object

Show Source

• 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

{
    "properties":{
        "carrierIdCode":{
            "type":"string"
        },
        "destinationGroup":{
            "type":"string"
        },
        "getpUser1":{
            "type":"string"
        },
        "getpUser2":{
            "type":"string"
        },
        "nextHop":{
            "type":"string"
        },
        "npa":{
            "type":"string"
        },
        "nxx":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "order":{
            "type":"string"
        },
        "preference":{
            "type":"string"
        },
        "pubId":{
            "type":"string"
        },
        "pubIdFormula":{
            "type":"string"
        },
        "routingNum":{
            "type":"string"
        },
        "sed":{
            "type":"string"
        },
        "sedFormula":{
            "type":"string"
        },
        "trunkContext":{
            "type":"string"
        },
        "trunkGroup":{
            "type":"string"
        },
        "user1":{
            "type":"string"
        },
        "user2":{
            "type":"string"
        },
        "user3":{
            "type":"string"
        },
        "user4":{
            "type":"string"
        },
        "user5":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSetEntry"
    }
}

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