Service Types API

get listing

GET /api/rest/admin/service-types

Parameters

Name	Description
filter[id]	id 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[force-renew-eq]	force renew eq filter
filter[force-renew-not-eq]	force renew not eq filter
filter[provisioning-class-eq]	provisioning class eq filter
filter[provisioning-class-not-eq]	provisioning class not eq filter
filter[provisioning-class-cont]	provisioning class cont filter
filter[provisioning-class-start]	provisioning class start filter
filter[provisioning-class-end]	provisioning class end filter
filter[provisioning-class-in]	provisioning class in filter
filter[provisioning-class-not-in]	provisioning class not in filter
filter[provisioning-class-cont-any]	provisioning class cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIyNiwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAxMH0.9QV56l2_4RfXfgOCjhDpzhZPzd8afnHso105WPs0ps4
Host: example.org
Cookie: 

Route

GET /api/rest/admin/service-types

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/"a9b01afe859f677ce75426ec6c1c8606"
cache-control: max-age=0, private, must-revalidate
x-request-id: 167b28c4-b936-4166-9737-a02b05aa348d
x-runtime: 0.006281
content-length: 718

Status

200 OK

Body

{
  "data": [
    {
      "id": "7",
      "type": "service-types",
      "links": {
        "self": "http://example.org/api/rest/admin/service-types/7"
      },
      "attributes": {
        "name": "Service Type 7",
        "force-renew": false,
        "provisioning-class": "Billing::Provisioning::Logging",
        "variables": {
          "foo": "bar"
        }
      }
    },
    {
      "id": "8",
      "type": "service-types",
      "links": {
        "self": "http://example.org/api/rest/admin/service-types/8"
      },
      "attributes": {
        "name": "Service Type 8",
        "force-renew": false,
        "provisioning-class": "Billing::Provisioning::Logging",
        "variables": {
          "foo": "bar"
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/service-types?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/service-types?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}