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>]

integer

Optional

Filtering

includes

string

Optional

Inclusion

sort

string

Optional

Sorting

Includes:

Value

Description

country

Country Object

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Region id field.

name

string

Yes

Yes

Region name field.

country.id

integer

Yes

Yes

A country.id field.

Sorting:

Value

Sorts by:

name

Region name field.

Examples

http

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

curl -i https://api.didww.com/v3/regions -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API Token]' -H 'Content-Type: application/vnd.api+json'

response

HTTP/2 200 OK
Content-Type: application/vnd.api+json

{
     "data": {
         "id": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
         "type": "regions",
         "attributes": {
             "name": "Alberta"
         },
         "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"
                 }
             }
         }
     },
     "meta": {
         "api_version": "2017-09-18"
     }
 }

http

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

curl -i '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'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [{
        "id": "e2f3f115-11f1-43cf-8279-08b29d94403d",
        "type": "regions",
        "attributes": {
            "name": "Alberta"
        },
        "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"
                }
            }
        }
    }],
    "meta": {
        "api_version": "2017-09-18"
    }
}

http

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

curl -i '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'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "id": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
            "type": "regions",
            "attributes": {
                "name": "Alberta"
            },
            "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"
                    },
                    "data": {
                        "type": "countries",
                        "id": "fa914558-9c64-4e01-967b-3302bd65a97b"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "fa914558-9c64-4e01-967b-3302bd65a97b",
            "type": "countries",
            "attributes": {
                "name": "Canada",
                "prefix": "1",
                "iso": "CA"
            },
            "relationships": {
                "regions": {
                    "links": {
                        "self": "https://api.didww.com/v3/countries/24eb6e85-f628-4765-bbb2-420e48de76f2/relationships/regions",
                        "related": "https://api.didww.com/v3/countries/24eb6e85-f628-4765-bbb2-420e48de76f2/regions"
                    }
                }
            }
        }
    ],
    "meta": {
        "api_version": "2017-09-18"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized