Get Region
Description
Returns a single Region.
Request
HTTP Method: GET
URI Path: /v3/regions/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
id |
|
Yes |
Unique ID identifier for the Region |
include |
|
No |
Examples
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 -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"
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"
}
}
}
}
}
GET /v3/regions/e2f3f115-11f1-43cf-8279-08b29d94403d?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/regions/e2f3f115-11f1-43cf-8279-08b29d94403d?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": "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"
}
}
}
},
"included": [
{
"id": "fa914558-9c64-4e01-967b-3302bd65a97b",
"type": "countries",
"attributes": {
"name": "Canada",
"prefix": "1",
"iso": "CA"
}
}
]
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |