Sign in

v1

latestOpenAPI 3.0.02026-08-06224588.5 KB
Areas of Use

Get Areas of Use

Get Area of Use records - returning named bounding box definitions in latitude and longitude.

get/area

Query parameters

offsetinteger

The offset of the first item in the list.

limitinteger

The maximum number of items returned.

modestring

The mode of return: 'persistable_reference' (default) string or 'essence' structure or 'persistable_reference_essence' i.e. the combination of other 2 options.

Headers

data-partition-idstring required

desired data partition id

Response

A successful response

countinteger

Number of elements in the response.

offsetinteger

Offset to the first catalog item in the response, as set in the request.

totalCountinteger

Number of elements in the catalog.

Example response

{
  "areasOfUse": [
    {
      "essence": {
        "type": "AOU",
        "authCode": {
          "auth": "EPSG",
          "code": "4326"
        }
      }
    }
  ]
}