Disallowed codes
List block codes.
Use the filter
query parameter to retrieve just a subset of a collection.
Use the search
query parameter to restrict the results of a request to match a search criterion.
Use the orderby
query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip
query parameter to set the number of items to skip at the start of a collection.
0
Use the top
query parameter to specify the page size of the result set.
100
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.
The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.
The description of blocked code.
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 details of blocked code by it's unique ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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 by it's ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of blocked code.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.
The description of blocked code.
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