Sign in

v1

latestOpenAPI 3.0.02026-08-06224588.5 KB
Areas of Use

Get one Area of Use

Get one Area of Use record by essence - returning a named bounding box definition in latitude and longitude.

post/area

Query parameters

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

persistableReferencestring

The persistable reference string, either the essence of the AreaOfUse serialized into a JSON string or an encoded string (version 1).

Example request

{
  "persistableReference": "{\"boundBox\":{\"lonMin\":116.89,\"latMin\":7.75,\"lonMax\":118.0,\"latMax\":9.32},\"authCode\":{\"auth\":\"EPSG\",\"code\":\"3958\"},\"type\":\"AOU\"}",
  "essence": {
    "authCode": {
      "auth": "EPSG",
      "code": "3958"
    },
    "boundBox": {
      "latMin": 7.75,
      "latMax": 9.32,
      "lonMin": 116.89,
      "lonMax": 118
    },
    "type": "AOU"
  }
}

Response

A successful response

idstring

The Internal Id of the AreaOfUse.

namestring

The name of the AreaOfUse.

descriptionstring

The description of the AreaOfUse.

lastModifiedstring

The LastModified of the AreaOfUse.

Example response

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