Sign in

v1

latestOpenAPI 3.0.02026-08-06224588.5 KB
Areas of Use

Search Areas of Use

Search Area of Use records by keywords and/or geographic area - returning named bounding box definitions in latitude and longitude. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:', 'description:', 'authority:', 'code:', 'deprecationState:', 'remarks:' (deprecationState remarks), 'lastModified:'. Example 'name:America'. longitudeLeft - the left WGS 84 longitude limit of the search box. latitudeLower - the lower WGS 84 latitude limit of the search box. longitudeRight - the right WGS 84 longitude limit of the search box. latitudeUpper - The upper WGS 84 latitude limit of the search box.

post/search/area

Query parameters

longitudeLeftnumber double
latitudeLowernumber double
longitudeRightnumber double
latitudeUppernumber double
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

Request body

querystring

The Lucene style query string with keywords.

Example request

{
  "query": "description:*America*"
}

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