v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
coverage boundaries

Survey resource boundaries that intersect with a polygon

Return all survey resources with boundaries that intersect with the given polygon specified in the path. Sorted by date in ascending order.

get/surveyresources/boundaries.{fileFormat}

Path parameters

fileFormat'geojson' required

Response file format.

Query parameters

polygonstring

The polygon for which the surveys are retrieved. The polygon is depicted by a set of lon,lat pairs, where the first and the last points must be the same. Either the polygon or line parameter must be specified.

linestring

The line for which the surveys are retrieved. The line is depicted by a set of lon,lat pairs. Either the polygon or line parameter must be specified.

limitinteger

Number of survey resources to return.

offsetinteger

Zero-based index of first record in the result.

sincestring

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.

untilstring

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.

resourcesstring

Comma separated list of resource classes 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.

overlapstring

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.

includestring

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

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

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 ascending.

Response

Survey resources with boundaries matching criteria.

type'FeatureCollection'
limitinteger

The limit of the total number of survey resources returned, as specified in the request

offsetinteger

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

totalinteger

The total number of survey resources available for this request