Rateplans API

get listing

GET /api/rest/admin/routing/rateplans

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[profit-control-mode-id-eq]	profit control mode id eq filter
filter[profit-control-mode-id-not-eq]	profit control mode id not eq filter
filter[profit-control-mode-id-gt]	profit control mode id gt filter
filter[profit-control-mode-id-gteq]	profit control mode id gteq filter
filter[profit-control-mode-id-lt]	profit control mode id lt filter
filter[profit-control-mode-id-lteq]	profit control mode id lteq filter
filter[profit-control-mode-id-in]	profit control mode id in filter
filter[profit-control-mode-id-not-in]	profit control mode id not in filter

Request

Headers

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

Route

GET /api/rest/admin/routing/rateplans

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/"d4908ef5690112dbdd594e993e98da26"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2d961d67-b3b8-4ab5-93de-80879c4521ed
X-Runtime: 0.013002
Content-Length: 574

Status

200 OK

Body

{
  "data": [
    {
      "id": "20",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/admin/routing/rateplans/20"
      },
      "attributes": {
        "name": "rateplan7",
        "profit-control-mode-id": 2
      }
    },
    {
      "id": "21",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/admin/routing/rateplans/21"
      },
      "attributes": {
        "name": "rateplan8",
        "profit-control-mode-id": 2
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/routing/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/routing/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}