Get Area

Returns an area for a given area ID. Note that a unique identification number is allocated to each area.

Request

HTTP Method: GET

URI Path: /v3/areas/

Note

For all returned data attributes, see Area Object.

URI Query Parameters

Name	Type	Is Required?	Description
id	string	Yes	Unique ID number for the area.
include	string	No	Inclusion.

Includes

Value	Description
country	Country Object

Examples

Simple RequestInclude Country

http

GET /v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3 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/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3 -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": "9fcc7390-84a2-47f1-a900-0558cdcb6ce3",
    "type": "areas",
    "attributes": {
      "name": "Tuscany"
    },
    "relationships": {
      "country": {
        "links": {
          "self": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/relationships/country",
          "related": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/country"
        }
      }
    }
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized