Get Region

Returns a single Region.

Request

HTTP Method: GET

URI Path: /v3/regions/

Note

For all returned data attributes, see Region Object.

URI Query Parameters

Name	Type	Is Required?	Description
id	string	Yes	Unique ID identifier for the Region
include	string	No	Inclusion

Examples

Simple RequestInclude Country

http

GET /v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733 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/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733 -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": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
        "type": "regions",
        "attributes": {
            "name": "Alberta",
            "iso": "CA-AB"
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/relationships/country",
                    "related": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"
                }
            }
        }
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized