v1

latestOpenAPI 3.0.1Apache License 2.02026-07-1795154.4 KB
Data

fetch features

Fetch features.

get/items

Query parameters

bboxnumber[]

Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):

  • Lower left corner, coordinate axis 1
  • Lower left corner, coordinate axis 2
  • Lower left corner, coordinate axis 3 (optional)
  • Upper right corner, coordinate axis 1
  • Upper right corner, coordinate axis 2
  • Upper right corner, coordinate axis 3 (optional)

The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.

For WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).

If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):

  • Lower left corner, coordinate axis 1
  • Lower left corner, coordinate axis 2
  • Lower left corner, coordinate axis 3 (optional)
  • Upper right corner, coordinate axis 1
  • Upper right corner, coordinate axis 2
  • Upper right corner, coordinate axis 3 (optional)

The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.

For WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).

If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

[
  -179,
  -89,
  179,
  89
]
datetimestring

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.

Examples:

  • A date-time: "2019-04-12T23:20:50Z"
  • A closed interval: "2019-04-12T00:00:00Z/2019-08-18T21:31:12Z" Only features that have a temporal property that intersects the value of datetime are selected.

If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

Example:2019-04-12T00:00:00Z/2019-08-18T21:31:12Z

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339 Examples:

  • A date-time: "2019-04-12T23:20:50Z"
  • A closed interval: "2019-04-12T00:00:00Z/2019-08-18T22:31:12Z"

Only features that have a temporal property that intersects the value of datetime are selected.

If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

limitinteger

The maximum number of results to return (page size). Defaults to 50

Example:50

The maximum number of results to return (page size). Defaults to 10

nextstring

The token to retrieve the next set of results, e.g., offset, page, continuation token. Defaults to 0

Example:0

The token to retrieve the next set of results, e.g., offset, page, continuation token

idsstring[]

Array of Item ids to return. All other filter parameters that further restrict the number of search results (except next and limit) are ignored

Array of Item ids to return. All other filter parameters that further restrict the number of search results (except next and limit) are ignored

collectionsstring[]

Array of Collection IDs to include in the search for items. Only Items in one of the provided Collections will be searched

Array of Collection IDs to include in the search for items. Only Items in one of the provided Collections will be searched

Response

The response is a document consisting of features in the collection. The features included in the response are determined by the server based on the query parameters of the request. To support access to larger collections without overloading the client, the API supports paged access with links to the next page, if more features are selected that the page size.

The bbox and datetime parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box or time interval). The bbox parameter matches all features in the collection that are not associated with a location, too. The datetime parameter matches all features in the collection that are not associated with a time stamp or interval, too.

The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).