Emergency Numbers

Manage your Emergency numbers.

List emergency numbers

get

Get a collection of emergency numbers.

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

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/emergency_numbers

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "number_prefix": "example",
      "description": ""
    }
  ]
}

Add emergency number.

post

Add a new emergency number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

number_prefixstring · min: 1 · max: 64Optional

The emergency number prefix.

descriptionstring · max: 1024Optional

The emergency number description.

Responses

200

Created

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/emergency_numbers

HTTPcURLJavaScriptPython

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

{
  "number_prefix": "example",
  "description": ""
}

{
  "id": "xxxxxxxx"
}

Retrieve emergency number

get

Get detail information of emergency number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

number_prefixstring · min: 1 · max: 64Optional

The emergency number prefix.

descriptionstring · max: 1024Optional

The emergency number description.

4XX

Error

get/emergency_numbers/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "xxxxxx",
  "number_prefix": "example",
  "description": ""
}

Update emergency number

post

Update a emergency number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

number_prefixstring · min: 1 · max: 64Optional

The emergency number prefix.

descriptionstring · max: 1024Optional

The emergency number description.

Responses

200

OK

No content

4XX

Error

post/emergency_numbers/{id}

HTTPcURLJavaScriptPython

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

{
  "number_prefix": "example",
  "description": ""
}

No content

Delete emergency number

post

Delete emergency number

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the emergency number.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

4XX

Error

post/emergency_numbers/{id}/destroy

HTTPcURLJavaScriptPython

POST /api/emergency_numbers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content