Jump to

• Request
• Response

Modify Route Entry by Id

put

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

Use this (PUT) method to modify route set entry details based on specified ID that exist on the SDM server. user has to provide route set Id, route entry id as part of uri and route info as part of request body to update the specified route entry details.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• entryId: string
  The id of the route which needs modification.
• routeSetId: string
  The route set whose route entry needs modification.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The route data to be updated in route specified.

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 : 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