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

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

City id field.

name

string

Yes

Yes

City name field.

country.id

integer

Yes

Yes

A country.id field.

Sorting:

Value

Sorts by:

name

City name field.

Fielding:

Value

Returns:

name

City name attribute.

Examples

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 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-04-19"
   },
   "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"
   }
}

http

GET /v3/areas?filter%5Bname%5D=Tuscany&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8 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/areas?filter%5Bname%5D=Tuscany&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8' -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": "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-04-19"
  },
  "links": {
      "first": "https://api.didww.com/v3/areas?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&filter%5Bname%5D=Tuscany&page%5Bnumber%5D=1&page%5Bsize%5D=1000",
      "last": "https://api.didww.com/v3/areas?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&filter%5Bname%5D=Tuscany&page%5Bnumber%5D=1&page%5Bsize%5D=1000"
  }
}

http

GET /v3/areas?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/areas?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": "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"
          },
          "data": {
              "type": "countries",
              "id": "51d3fe2a-6588-496b-870c-398e627de5c4"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "51d3fe2a-6588-496b-870c-398e627de5c4",
      "type": "countries",
      "attributes": {
        "name": "Italy",
        "prefix": "39",
        "iso": "IT"
      }
    }
  ],
  "meta": {
      "total_records": 1,
      "api_version": "2021-04-19"
  },
  "links": {
      "first": "https://api.didww.com/v3/areas?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=1000",
      "last": "https://api.didww.com/v3/areas?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=1000"
  }
}

Other Responses

Code

Success

Description

401

No

Unauthorized