Get City
Description
Returns a city for a given city ID number. Note that a unique identification number is allocated to each city included in the DIDWW coverage.
Request
HTTP Method: GET
URI Path: /v3/cities/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
id |
|
Yes |
Unique ID number for the city |
include |
|
Optional |
Includes:
Value |
Description |
---|---|
country |
|
region |
|
area |
Examples
GET /v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API Token]
curl -i -X GET https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4 -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "cdf449bc-e3fb-42cc-bf31-b88f91e40de4",
"type": "cities",
"attributes": {
"name": "London"
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/relationships/country",
"related": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/country"
}
},
"region": {
"links": {
"self": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/relationships/region",
"related": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/country"
}
},
"area": {
"links": {
"self": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/relationships/area",
"related": "https://api.didww.com/v3/cities/cdf449bc-e3fb-42cc-bf31-b88f91e40de4/area"
}
}
}
}
}
GET /v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8?include=country HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API Token]
curl -i -X GET 'https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8?include=country' -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "498f2880-591f-436d-aacd-46ad3a7d8be8",
"type": "cities",
"attributes": {
"name": "London"
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/relationships/country",
"related": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/country"
},
"data": {
"type": "countries",
"id": "2e89d524-55b6-4b6c-a0af-3c1ed0f407f9"
}
},
"region": {
"links": {
"self": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/relationships/region",
"related": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/region"
}
},
"area": {
"links": {
"self": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/relationships/area",
"related": "https://api.didww.com/v3/cities/498f2880-591f-436d-aacd-46ad3a7d8be8/area"
}
}
}
},
"included": [
{
"id": "2e89d524-55b6-4b6c-a0af-3c1ed0f407f9",
"type": "countries",
"attributes": {
"name": "United Kingdom",
"prefix": "44",
"iso": "GB"
}
}
]
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |