Get City

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/

Note

For all returned data attributes, see City Object.

URI Query Parameters

Name	Type	Is Required?	Description
id	string	Yes	Unique ID identifier of the City.
include	string	No	Inclusion

Includes

Value	Description
country	Country Object
region	Region Object
area	Area Object

Examples

Simple RequestInclude Country

http

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

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"

response

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"
        }
      }
    }
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized