Disallowed codes

List block codes

get

List block codes.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/disallowed_codes

HTTPcURLJavaScriptPython

GET /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "number_prefix": "text",
      "description": "text"
    }
  ]
}

Create a block code

post

Create a block code.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

number_prefixstring · min: 1 · max: 16Optional

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024Optional

The description of blocked code.

Responses

201

Created

application/json

4XX

Error

post

/disallowed_codes

HTTPcURLJavaScriptPython

POST /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "number_prefix": "text",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve blocked code

get

Retrieve details of blocked code by it's unique ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/disallowed_codes/{id}

HTTPcURLJavaScriptPython

GET /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number_prefix": "text",
  "description": "text"
}

Update a blocked code

post

Update a blocked code by it's ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

idall ofOptional

The unique ID of blocked code.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

number_prefixstring · min: 1 · max: 16Optional

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024Optional

The description of blocked code.

Responses

200

OK

No content

4XX

Error

post

/disallowed_codes/{id}

HTTPcURLJavaScriptPython

POST /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number_prefix": "text",
  "description": "text"
}

No content