List dynamic emergency addresses

GET 
/dynamic_emergency_addresses

Returns the dynamic emergency addresses according to filters

Request

Query Parameters

filter[status] string

Possible values: [pending, activated, rejected]

Filter by status.

filter[country_code] string

Filter by country code.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: Dynamic Emergency Address Responses

application/json

Schema

Schema

data

object[]

Array [

id string

record_type string

Identifies the type of the resource.

sip_geolocation_id string

Unique location reference string to be used in SIP INVITE from / p-asserted headers.

status string

Possible values: [pending, activated, rejected]

Status of dynamic emergency address

house_number stringrequired

house_suffix string

street_pre_directional string

street_name stringrequired

street_suffix string

street_post_directional string

extended_address string

locality stringrequired

administrative_area stringrequired

postal_code stringrequired

country_code string

Possible values: [US, CA, PR]

created_at string

ISO 8601 formatted date of when the resource was created

updated_at string

ISO 8601 formatted date of when the resource was last updated

]

meta

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

Example (from schema)

{
  "data": [
    {
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
      "record_type": "dynamic_emergency_address",
      "sip_geolocation_id": "XYZ123",
      "status": "pending",
      "house_number": 311,
      "house_suffix": "string",
      "street_pre_directional": "W",
      "street_name": "Superior",
      "street_suffix": "string",
      "street_post_directional": "string",
      "extended_address": "string",
      "locality": "Chicago",
      "administrative_area": "IL",
      "postal_code": "60654",
      "country_code": "US",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}

401: Unauthorized

404: Resource not found

422: Unprocessable entity. Check message field in response for details.

Loading...