Get Areas

Description

Returns a list of areas. Maximum page size is 1000. Default page size is 1000.

Request

HTTP Method: GET

URI Path: /v3/areas

URI Query Parameters:

Name	Type	Is Required?	Description
filter[<filter_name>]	string	Optional	Filtering
include	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	Area id field.
name	string	Yes	Yes	Area name field. Case insensitive.
country.id	string	Yes	Yes	A country.id field.

Sorting:

Value	Sorts by:
name	City name field.

Sparse Fieldsets:

Value	Returns:
name	City name attribute.

Examples

Simple requestFilter by name or country.idInclude Country Resource

http

GET /v3/areas 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/areas -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": "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"
          }
        }
      }
    }
  ],
   "meta": {
       "total_records": 1,
       "api_version": "2021-12-15"
   },
   "links": {
       "first": "https://api.didww.com/v3/areas?page%5Bnumber%5D=1&page%5Bsize%5D=1000",
       "last": "https://api.didww.com/v3/areas?page%5Bnumber%5D=1&page%5Bsize%5D=1000"
   }
}

Other Responses

Code	Success	Description
401	No	Unauthorized