Get Area

GET https://{{host}}/v3/areas/:id

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

Request Params

KeyDatatypeRequiredDescription
includenullComma-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 |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"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"},"data":{"type":"countries","id":"51d3fe2a-6588-496b-870c-398e627de5c4"}}}},"included":[{"id":"51d3fe2a-6588-496b-870c-398e627de5c4","type":"countries","attributes":{"name":"Italy","prefix":"39","iso":"IT"}}],"meta":{"api_version":"2021-04-19"}}