Disallowed codes

List block codes

List block codes.

GEThttp://127.0.0.1:8888/api/disallowed_codes

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/disallowed_codes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a block code

Create a block code.

POSThttp://127.0.0.1:8888/api/disallowed_codes

Body

application/json

number_prefixstring

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

descriptionstring

The description of blocked code.

Response

2014XX

Created

Body

application/json

idstring

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/disallowed_codes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve blocked code

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

GEThttp://127.0.0.1:8888/api/disallowed_codes/{id}

Path parameters

id*string

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Response

2004XX

OK

Body

application/json

idall of

The unique ID of blocked code.

number_prefixstring

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

descriptionstring

The description of blocked code.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/disallowed_codes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a blocked code

Update a blocked code by it's ID.

POSThttp://127.0.0.1:8888/api/disallowed_codes/{id}

Path parameters

id*string

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Body

application/json

idall of

The unique ID of blocked code.

number_prefixstring

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

descriptionstring

The description of blocked code.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/disallowed_codes/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();