Routing plans API

get listing

GET /api/rest/admin/routing-plans

Parameters

Name Description
filter[id] id filter
filter[name] name filter
filter[name-eq] name eq filter
filter[name-not-eq] name not eq filter
filter[name-cont] name cont filter
filter[name-start] name start filter
filter[name-end] name end filter
filter[name-in] name in filter
filter[name-not-in] name not in filter
filter[name-cont-any] name cont any filter
filter[rate-delta-max-eq] rate delta max eq filter
filter[rate-delta-max-not-eq] rate delta max not eq filter
filter[rate-delta-max-gt] rate delta max gt filter
filter[rate-delta-max-gteq] rate delta max gteq filter
filter[rate-delta-max-lt] rate delta max lt filter
filter[rate-delta-max-lteq] rate delta max lteq filter
filter[rate-delta-max-in] rate delta max in filter
filter[rate-delta-max-not-in] rate delta max not in filter
filter[use-lnp-eq] use lnp eq filter
filter[use-lnp-not-eq] use lnp not eq filter
filter[max-rerouting-attempts-eq] max rerouting attempts eq filter
filter[max-rerouting-attempts-not-eq] max rerouting attempts not eq filter
filter[max-rerouting-attempts-gt] max rerouting attempts gt filter
filter[max-rerouting-attempts-gteq] max rerouting attempts gteq filter
filter[max-rerouting-attempts-lt] max rerouting attempts lt filter
filter[max-rerouting-attempts-lteq] max rerouting attempts lteq filter
filter[max-rerouting-attempts-in] max rerouting attempts in filter
filter[max-rerouting-attempts-not-in] max rerouting attempts not in filter
filter[validate-dst-number-format-eq] validate dst number format eq filter
filter[validate-dst-number-format-not-eq] validate dst number format not eq filter
filter[validate-dst-number-network-eq] validate dst number network eq filter
filter[validate-dst-number-network-not-eq] validate dst number network not eq filter
filter[external-id-eq] external id eq filter
filter[external-id-not-eq] external id not eq filter
filter[external-id-gt] external id gt filter
filter[external-id-gteq] external id gteq filter
filter[external-id-lt] external id lt filter
filter[external-id-lteq] external id lteq filter
filter[external-id-in] external id in filter
filter[external-id-not-in] external id not in filter
filter[sorting-id-eq] sorting id eq filter
filter[sorting-id-not-eq] sorting id not eq filter
filter[sorting-id-gt] sorting id gt filter
filter[sorting-id-gteq] sorting id gteq filter
filter[sorting-id-lt] sorting id lt filter
filter[sorting-id-lteq] sorting id lteq filter
filter[sorting-id-in] sorting id in filter
filter[sorting-id-not-in] sorting id not in filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTAyNTQ3MzcsInN1YiI6MTg0fQ.-xSWOYbvOJpyoEYLWkkFDti2C3DXQzlo7VaLyvrSXIY
Host: example.org
Cookie: 

Route

GET /api/rest/admin/routing-plans

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"90a0bc10554351b3982508c8db159d3f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 14ed93ee-d48d-4e50-851c-92e62ce671d3
X-Runtime: 0.007477
Content-Length: 680

Status

200 OK

Body

{
  "data": [
    {
      "id": "7",
      "type": "routing-plans",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-plans/7"
      },
      "attributes": {
        "name": "routing_plan_7",
        "rate-delta-max": "0.0",
        "use-lnp": false,
        "max-rerouting-attempts": 9,
        "sorting-id": 1
      }
    },
    {
      "id": "8",
      "type": "routing-plans",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-plans/8"
      },
      "attributes": {
        "name": "routing_plan_8",
        "rate-delta-max": "0.0",
        "use-lnp": false,
        "max-rerouting-attempts": 9,
        "sorting-id": 1
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/routing-plans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/routing-plans?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}