Routing AreaPrefix API

get listing

GET /api/rest/admin/area-prefixes

Parameters

Name	Description
filter[id]	id filter
filter[prefix-eq]	prefix eq filter
filter[prefix-not-eq]	prefix not eq filter
filter[prefix-cont]	prefix cont filter
filter[prefix-start]	prefix start filter
filter[prefix-end]	prefix end filter
filter[prefix-in]	prefix in filter
filter[prefix-not-in]	prefix not in filter
filter[prefix-cont-any]	prefix cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjMwLCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzY3MzU4NTYwfQ.NiC_GNcDaYwA2GZUL5_xEc7bKB1fLN2d-QmY7-bt6wQ
Host: example.org
Cookie: 

Route

GET /api/rest/admin/area-prefixes

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"757045f1493090854dc9a749eea1c3de"
cache-control: max-age=0, private, must-revalidate
x-request-id: 7e38eede-a3ab-44c9-9689-b19c683fcabc
x-runtime: 0.007696
content-length: 864

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "area-prefixes",
      "links": {
        "self": "http://example.org/api/rest/admin/area-prefixes/1"
      },
      "attributes": {
        "prefix": "123"
      },
      "relationships": {
        "area": {
          "links": {
            "self": "http://example.org/api/rest/admin/area-prefixes/1/relationships/area",
            "related": "http://example.org/api/rest/admin/area-prefixes/1/area"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "area-prefixes",
      "links": {
        "self": "http://example.org/api/rest/admin/area-prefixes/2"
      },
      "attributes": {
        "prefix": "234"
      },
      "relationships": {
        "area": {
          "links": {
            "self": "http://example.org/api/rest/admin/area-prefixes/2/relationships/area",
            "related": "http://example.org/api/rest/admin/area-prefixes/2/area"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/area-prefixes?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/area-prefixes?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}