Sign in

v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
coverage

Survey resources that intersect within an area of interest (polygon or multipolygon)

Return all survey resources that intersect with the given aoi specified in POST body.

post/aoi

Query parameters

limitinteger

Number of survey records to return.

offsetinteger

Zero-based index of first record in the result.

sortstring

Name of field to sort results by, with a prefix of "-" indicating to sort in descending order. Only one field can be specified. Default is by capture date descending.

fieldsstring

Comma separated list of survey fields to include in the response. Default is all fields.

Request body

untilstring required

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD".

sincestring required

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD".

resourcesstring required

Comma separated list of resource types to include in the response in the form of "resourceClass:type" where ":type" is optional and represents all types of a resource class if not present. If not specified then all types are returned.

modestring required

Overlap mode, can be "all" or "full", default is "all". "all" means input polygon intersect with content's polygon, "full" means input polygon within content's polygon.

aoiobject required

Polygon or multipolygon describing the area of interest for the query

includestring required

Specify tags survey resource should include, return survey resource that match AT LEAST ONE of exposed tag \ Comma separated tag query strings. Tag structure is TagType:TagName \ Single tag query can be TagType only, match same tag type with any tag value. \ Supported tag types are present in the coverage response

excludestring required

Specify tags survey resource should exclude, return survey resource does NOT match any exposed tag\ Comma separated tag query strings. Tag structure is TagType:TagName \ Single tag query can be TagType only, match same tag type with any tag value. \ Supported tag types are present in the coverage response

Example request

{
  "until": "2024-01-01",
  "since": "2023-01-01",
  "resources": "tiles:Vert",
  "mode": "all",
  "aoi": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          151.1675,
          -33.89072
        ],
        [
          151.1676,
          -33.89151
        ],
        [
          151.16803,
          -33.89147
        ],
        [
          151.16796,
          -33.89109
        ],
        [
          151.16794,
          -33.89074
        ],
        [
          151.16787,
          -33.89068
        ],
        [
          151.1675,
          -33.89072
        ]
      ]
    ]
  },
  "include": "disaster:flood,disaster:hurricane",
  "exclude": "disaster:flood,disaster:hurricane"
}

Response

Survey resources matching criteria

limitinteger

the limit of the total number of surveys returned, as specified in the request

offsetinteger

the offset of the first survey to be displayed, as specified in the request

totalinteger

the total number of surveys available for this request

Example response

{
  "surveys": [
    {
      "tags": {
        "postCatEventType": "hurricane",
        "postCatEventName": "Hurricane Idalia",
        "postCatEventDate": "2023-08-30"
      }
    }
  ]
}