Get Cities
GET https://{{host}}/v3/cities
Returns a list of cities. Maximum page size is 1000. Default page size is 1000.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
country - Country Object
region - Region Object
*** |
| filter[id] | null | | string - Filters by city id field.
-
Allow blank - No.
-
Allow array - Yes. | |
filter[name]| null | |string- Filters by city name field. -
Allow blank - Yes.
-
Allow array - Yes. | |
filter[country.id]| null | |integer- A country.id field. -
Allow blank - Yes.
-
Allow array - Yes. | |
filter[region.id]| null | |integer- A region.id field. -
Allow blank - Yes.
-
Allow array - Yes. | |
filter[is_available]| null | |boolean- When true, shows cities which have DID groups in coverage with DID numbers available for purchase. When false shows cities which have DID groups without DID numbers available for purchase. -
Allow blank - No.
-
Allow array - No. | |
sort| null | | Used for sorting the fields returned by the request, with a comma,separating the included fields. Details in Sorting Article.
name - City name field.
*** |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"79c1ee51-a2dd-4fb2-8c08-ab9120909118","type":"cities","attributes":{"name":"Springfield"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/country","related":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/country"}},"region":{"links":{"self":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/region","related":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/region"}}}}],"meta":{"total_records":1,"api_version":"2017-09-18"},"links":{"first":"https://api.didww.com/v3/cities?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8\u0026filter%5Bname%5D=Springfield\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=1000","last":"https://api.didww.com/v3/cities?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8\u0026filter%5Bname%5D=Springfield\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=1000"}}