Sign in

v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
coverage

Survey resources that intersect with a point

Return all survey resources that intersect with a point specified in the path.

get/point/{coord}

Path parameters

coordstring required

The point for which the surveys are retrieved. The point is the longitude and latitude of the location in the format LONG,LAT. For example, -122.008946,37.334849. Any coordinate containing "nan" or "inf" will result in an error as these are invalid longitude/latitude values.

Query parameters

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

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.

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

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