Get Regions
Description
Returns a collection of Regions. Pagination is disabled.
Request
HTTP Method: GET
URI Path: /v3/regions
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
filter[<filter_name>] |
|
No |
|
include |
|
No |
|
sort |
|
No |
Includes:
Value |
Description |
---|---|
country |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
---|---|---|---|---|
id |
|
No |
Yes |
Region |
name |
|
Yes |
Yes |
Region |
country.id |
|
Yes |
Yes |
A |
iso |
|
No |
Yes |
Region |
Sorting:
Value |
Sort by |
---|---|
name |
Region |
Fielding:
Value |
Return |
---|---|
name |
Region |
Examples
GET /v3/regions 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 -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
HTTP/2 200 OK
Content-Type: application/vnd.api+json
{
"data":{
"id": "e2f3f115-11f1-43cf-8279-08b29d94403d",
"type": "regions",
"attributes": {
"name": "Alberta",
"iso": "CA-AB"
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/regions/e2f3f115-11f1-43cf-8279-08b29d94403d/relationships/country",
"related": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"
}
}
}
}
}
GET /v3/regions?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&sort=-name 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?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&sort=-name' -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": "525dab52-0f4b-43cb-b1f6-83ee97a0b5ff",
"type": "regions",
"attributes": {
"name": "Wyoming",
"iso": "US-WY"
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/regions/525dab52-0f4b-43cb-b1f6-83ee97a0b5ff/relationships/country",
"related": "https://api.didww.com/v3/regions/525dab52-0f4b-43cb-b1f6-83ee97a0b5ff/country"
}
}
}
}
}
GET /v3/regions?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?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 |