# info.description
Have you ever wondered where the wine that you are drinking comes from? If the wine comes from the wine-growing regions Mosel, Nahe, Rheinhessen, Pfalz, Ahr, or Mittelrhein you can find this information in this API.

The dataset shared by this API is the vineyard register (Weinbergsrolle) of Rhineland-Palatinate, available under an open-data license. It is managed by the Chamber of Agriculture of Rhineland-Palatinate (Landwirtschaftskammer RLP).
© Landwirtschaftskammer RLP (2020), dl-de/by-2-0, weinlagen.lwk-rlp.de; Regelungen zu Gewährleistung und Haftung

This API is a demo for APIs that can be deployed using ldproxy based on the OGC API standards developed by the Open Geospatial Consortium. A description how to set this API is available here. _Note: This API is based on API building blocks (e.g., operations, query parameters, or headers) specified in OGC API Standards or drafts of those standards. For more information about OGC API Standards, see [https://ogcapi.ogc.org](https://ogcapi.ogc.org/). Some building blocks of this API can be preliminary and may change in this API, because they are not yet based on a stable specification. The maturity is stated for each building block._

# info.license.name
Datenlizenz Deutschland - Namensnennung - Version 2.0

# paths./.get.description
The landing page provides links to the API definition (link relations `service-desc` and `service-doc`), the Conformance declaration (path `/conformance`, link relation `conformance`), and other resources in the API.

_Maturity: `STABLE`_

# paths./.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./.get.responses.200.description
The operation was executed successfully.

# paths./conformance.get.description
The URIs of all conformance classes supported by the server. This information is provided to support 'generic' clients that want to access multiple OGC API implementations - and not 'just' a specific API. For clients accessing only a single API, this information is in general not relevant and the OpenAPI definition details the required information about the API.

_Maturity: `STABLE`_

# paths./conformance.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./conformance.get.responses.200.description
The operation was executed successfully.

# paths./mcp/schema.get.description
Check the generated MCP definitions.

_Maturity: `PRELIMINARY` (the operation may change in this API)_

# paths./mcp/schema.get.responses.200.description
The operation was executed successfully.

# paths./mcp.post.description
Can be added to AI tools as connector.

_Maturity: `PRELIMINARY` (the operation may change in this API)_

# paths./mcp.post.responses.200.description
The operation was executed successfully.

# paths./collections.get.summary
feature collections in the dataset 'Vineyards in Rhineland-Palatinate, Germany'

# paths./collections.get.description
The dataset is organized in feature collections. This resource provides information about and access to the feature collections.
The response contains the list of collections. For each collection, a link to the items in the collection (path `/collections/{collectionId}/items`, link relation `items`) as well as key information about the collection.
This information includes:

* A local identifier for the collection that is unique for the dataset;
* A title and description for the collection;
* An indication of the spatial and temporal extent of the data in the collection;
* A list of coordinate reference systems (CRS) in which geometries may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
* The CRS in which the spatial geometries are stored in the data source (if data is requested in this CRS, the geometries are returned without any coordinate conversion);
* An indicator about the type of the items in the collection (the default value is 'feature').

_Maturity: `STABLE`_

# paths./collections.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./collections.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards.get.description
Information about the feature collection with id 'vineyards'. The response contains a link to the items in the collection (path `/collections/{collectionId}/items`,link relation `items`) as well as key information about the collection. This information includes:

* A local identifier for the collection that is unique for the dataset;
* A title and description for the collection;
* An indication of the spatial and temporal extent of the data in the collection;
* A list of coordinate reference systems (CRS) in which geometries may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
* The CRS in which the spatial geometries are stored in the data source (if data is requested in this CRS, the geometries are returned without any coordinate conversion);
* An indicator about the type of the items in the collection (the default value is 'feature').

_Maturity: `STABLE`_

# paths./collections/vineyards.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./collections/vineyards.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards/items/{featureId}.get.summary
retrieve a feature in the feature collection 'vineyards'

# paths./collections/vineyards/items/{featureId}.get.description
Fetch the feature with id `{featureId}`.

_Maturity: `STABLE`_

# paths./collections/vineyards/items/{featureId}.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./collections/vineyards/items/{featureId}.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards/items.get.summary
retrieve features in the feature collection 'vineyards'

# paths./collections/vineyards/items.get.description
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 (maximum page size is 100000).

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

See the details of this operation for a description of additional query parameters supported by this resource.

_Maturity: `STABLE`_

# paths./collections/vineyards/items.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 1: Core

# paths./collections/vineyards/items.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards/queryables.get.summary
retrieve the queryables of the feature collection 'vineyards'

# paths./collections/vineyards/queryables.get.description
The Queryables resources identifies the properties that can be referenced in filter expressions to select specific features that meet the criteria identified in the filter. The response is a JSON Schema document that describes a single JSON object where each property is a queryable.

Note: The queryables schema does not specify a schema of any object that can be retrieved from the API.

The descriptive metadata (title and description of the property) as well as the schema information (data type and constraints like a list of allowed values or minimum/maxmimum values are provided to support clients to constructmeaningful queries for the data.

_Maturity: `STABLE`_

# paths./collections/vineyards/queryables.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 3: Filtering

# paths./collections/vineyards/queryables.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards/sortables.get.summary
retrieve the sortables of the feature collection 'vineyards'

# paths./collections/vineyards/sortables.get.description
The sortables resources identifies the properties that can bereferenced in the 'sortby' parameter to order the features of the collection in the response to a query.The response is returned as a JSON Schema document that describes a single JSON object where each property is a sortable.

Note that the sortables schema does not specify a schema of any object that can be retrieved from the API.

JSON Schema is used for the sortables to have a consistent approach for describing schema information and JSON Schema is/will be used in other parts of OGC API Features to describe schemas for GeoJSON feature content including in OpenAPI documents.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./collections/vineyards/sortables.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 8: Sorting (DRAFT)

# paths./collections/vineyards/sortables.get.responses.200.description
The operation was executed successfully.

# paths./collections/vineyards/schema.get.summary
retrieve the schema of features in the feature collection 'vineyards'

# paths./collections/vineyards/schema.get.description
Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)

# paths./collections/vineyards/schema.get.externalDocs.description
The specification that describes this operation: OGC API - Features - Part 5: Schemas (DRAFT)

# paths./collections/vineyards/schema.get.responses.200.description
The operation was executed successfully.

# paths./tiles.get.summary
retrieve a list of the available tile sets

# paths./tiles.get.description
This operation fetches the list of multi-layer tile sets supported by this API.

_Maturity: `STABLE`_

# paths./tiles.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./tiles.get.responses.200.description
The operation was executed successfully.

# paths./tiles/{tileMatrixSetId}.get.description
This operation fetches information about a tile set.

_Maturity: `STABLE`_

# paths./tiles/{tileMatrixSetId}.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./tiles/{tileMatrixSetId}.get.responses.200.description
The operation was executed successfully.

# paths./tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}.get.summary
fetch a tile with multiple layers, one per collection

# paths./tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}.get.description
The tile in the requested tiling scheme ('{tileMatrixSetId}'), on the requested zoom level ('{tileMatrix}'), with the requested grid coordinates ('{tileRow}', '{tileCol}') is returned. The tile has one layer per collection with all selected features in the bounding box of the tile with the requested properties.

_Maturity: `STABLE`_

# paths./tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/tiles.get.summary
retrieve a list of the available tile sets

# paths./collections/{collectionId}/tiles.get.description
This operation fetches the list of tile sets available for this collection.

_Maturity: `STABLE`_

# paths./collections/{collectionId}/tiles.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./collections/{collectionId}/tiles.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}.get.description
This operation fetches information about a tile set.

_Maturity: `STABLE`_

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}.get.summary
fetch a tile of the collection '{collectionId}'

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}.get.description
The tile in the requested tiling scheme ('{tileMatrixSetId}'), on the requested zoom level ('{tileMatrix}'), with the requested grid coordinates ('{tileRow}', '{tileCol}') is returned. The tile has a single layer with all selected features in the bounding box of the tile with the requested properties.

_Maturity: `STABLE`_

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}.get.responses.200.description
The operation was executed successfully.

# paths./tileMatrixSets.get.summary
retrieve a list of the available tiling schemes

# paths./tileMatrixSets.get.description
This operation fetches the set of tiling schemes supported by this API. For each tiling scheme the id, a title and the link to the tiling scheme object is provided.

_Maturity: `STABLE`_

# paths./tileMatrixSets.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./tileMatrixSets.get.responses.200.description
The operation was executed successfully.

# paths./tileMatrixSets/{tileMatrixSetId}.get.summary
fetch information about the tiling scheme `{tileMatrixSetId}`

# paths./tileMatrixSets/{tileMatrixSetId}.get.description
Returns the definition of the tiling scheme according to the [OGC Two Dimensional Tile Matrix Set standard](https://docs.ogc.org/is/17-083r2/17-083r2.html).

_Maturity: `STABLE`_

# paths./tileMatrixSets/{tileMatrixSetId}.get.externalDocs.description
The specification that describes this operation: OGC API - Tiles - Part 1: Core

# paths./tileMatrixSets/{tileMatrixSetId}.get.responses.200.description
The operation was executed successfully.

# paths./styles.get.description
This operation fetches the set of styles available. For each style the id, a title, links to the stylesheet of the style in each supported encoding, and the link to the metadata is provided.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./styles.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./styles.get.responses.200.description
The operation was executed successfully.

# paths./styles/{styleId}.get.description
Fetches the style with identifier `styleId`. The set of available styles can be retrieved at `/styles`. Not all styles are available in all style encodings.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./styles/{styleId}.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./styles/{styleId}.get.responses.200.description
The operation was executed successfully.

# paths./styles/{styleId}/metadata.get.summary
fetch metadata about the style `{styleId}`

# paths./styles/{styleId}/metadata.get.description
Style metadata is essential information about a style in order to support users to discover and select styles for rendering their data and for visual style editors to create user interfaces for editing a style. This operations returns the metadata for the requested style as a single document. The style metadata is derived from the style and the stylesheet.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./styles/{styleId}/metadata.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./styles/{styleId}/metadata.get.responses.200.description
The operation was executed successfully.

# paths./styles/{styleId}/legend.get.summary
fetch the legend of the style `{styleId}`

# paths./styles/{styleId}/legend.get.description
This endpoint retrieves the legend for a map style. The legend is provided as a PNG file, which can be used to understand the symbols and colors used in the map style.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./styles/{styleId}/legend.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./styles/{styleId}/legend.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/styles.get.summary
retrieve a list of the available styles for collection `{collectionId}`

# paths./collections/{collectionId}/styles.get.description
This operation fetches the set of styles available for this collection. For each style the id, a title, links to the stylesheet of the style in each supported encoding, and the link to the metadata is provided.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./collections/{collectionId}/styles.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./collections/{collectionId}/styles.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/styles/{styleId}.get.summary
fetch a style for collection `{collectionId}`

# paths./collections/{collectionId}/styles/{styleId}.get.description
Fetches the style with identifier `styleId`. The set of available styles can be retrieved at `/styles`. Not all styles are available in all style encodings.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./collections/{collectionId}/styles/{styleId}.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./collections/{collectionId}/styles/{styleId}.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/styles/{styleId}/metadata.get.summary
fetch metadata about the style `{styleId}` for collection `{collectionId}`

# paths./collections/{collectionId}/styles/{styleId}/metadata.get.description
Style metadata is essential information about a style in order to support users to discover and select styles for rendering their data and for visual style editors to create user interfaces for editing a style. This operations returns the metadata for the requested style as a single document. The stylesheet of the style will typically include some the metadata, too.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./collections/{collectionId}/styles/{styleId}/metadata.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./collections/{collectionId}/styles/{styleId}/metadata.get.responses.200.description
The operation was executed successfully.

# paths./collections/{collectionId}/styles/{styleId}/legend.get.summary
fetch the legend of the style `{styleId}` for collection `{collectionId}`

# paths./collections/{collectionId}/styles/{styleId}/legend.get.description
This endpoint retrieves the legend for a map style. The legend is provided as a PNG file, which can be used to understand the symbols and colors used in the map style.

_Maturity: `PRELIMINARY` (specified in a draft standard; the operation may change in this API)_

# paths./collections/{collectionId}/styles/{styleId}/legend.get.externalDocs.description
The specification that describes this operation: OGC API - Styles (DRAFT)

# paths./collections/{collectionId}/styles/{styleId}/legend.get.responses.200.description
The operation was executed successfully.

# components.schemas.featureGeoJson_vineyards.description
The vineyard register constitutes the authorized list of names of single vineyards, vineyards clusters (Großlagen), sub-regions (Bereiche) and wine-growing regions (Anbaugebiete) for the protected designation of origin for wines in the German state Rhineland-Palatinate. It is managed by the Chamber of Agriculture of Rhineland-Palatinate (Landwirtschaftskammer RLP).<br>
The data for each vineyard includes the vineyard register number, the wine-growing region, the sub-region, the vineyard cluster, the name of the single vineyard, the village(s), the cadastral district(s) and the area with vines in hectares. The six-digit vineyard register number contains in the first digit the wine-growing region, in the second digit the sub-region, in the third and fourth digit the vineyard cluster and in the fifth and sixth digit the single vineyard.

# components.schemas.featureCollectionGeoJson_vineyards.properties.timeStamp.description
This property indicates the time and date when the response was generated.

# components.schemas.featureCollectionGeoJson_vineyards.properties.numberMatched.properties.numberReturned.description
The number of features in the feature collection.

A server may omit this information in a response, if the information about the number of features is not known or difficult to compute.

If the value is provided, the value shall be identical to the number of items in the "features" array.

# components.schemas.featureCollectionGeoJson_vineyards.properties.numberMatched.description
The number of features of the feature type that match the selection parameters like `bbox`.

# components.parameters.access_token.description
Set the authorization token for the request. If no value is provided, the standard HTTP rules apply, i.e., the authorization header will be used to determine the token.

_Maturity: `STABLE`_

# components.parameters.fCommon.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.prettyCommon.description
Controls whether the response content should be pretty-printed. Only applicable for JSON responses.

# components.parameters.fCollections.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.fCollection.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.featureId.description
The local identifier of a feature, unique within the feature collection.

_Maturity: `STABLE`_

# components.parameters.crsFeatures_vineyards.description
The coordinate reference system of the response geometries. Default is WGS84 longitude/latitude (with or without height).

_Maturity: `STABLE`_

# components.parameters.exclude-properties_vineyards.description
The properties that should be excluded for each feature. The parameter value is a comma-separated list of property names. By default, all feature properties with a value are returned. The parameter must not be used together with the 'properties' parameter.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fFeatures.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.maxAllowableOffset.description
This option can be used to specify the maxAllowableOffset to be used for simplifying the geometries in the response. The maxAllowableOffset is in the units of the response coordinate reference system.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.prettyFeatures.description
Controls whether the response content should be pretty-printed. Only applicable for JSON responses.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.profileFeatures_vineyards.description
Select the profiles to be used in the response. If no value is provided, the default profiles will be used.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.properties_vineyards.description
The properties that should be included for each feature. The parameter value is a comma-separated list of property names. By default, all feature properties with a value are returned.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.skipGeometry_vineyards.description
Use this option to exclude geometries from the response for each feature.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.zoom-level.description
This option can be used to simplify geometries for the zoom level from the widely used tiling scheme in web mapping (WebMercatorQuad). The map scale of zoom level 0 is roughly 1:560 million. The scale doubles for every zoom level (e.g. zoom level 12 is 1:136495).

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.bbox.description
Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers:

* Lower left corner, coordinate axis 1 
* Lower left corner, coordinate axis 2 
* Upper right corner, coordinate axis 1 
* Upper right corner, coordinate axis 2 
The coordinate reference system of the values is WGS 84 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 WGS 84 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).

_Maturity: `STABLE`_

# components.parameters.bbox.schema.description
Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers:

* Lower left corner, coordinate axis 1 
* Lower left corner, coordinate axis 2 
* Upper right corner, coordinate axis 1 
* Upper right corner, coordinate axis 2 
The coordinate reference system of the values is WGS 84 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 WGS 84 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).

# components.parameters.bbox-crsFeatures_vineyards.description
The coordinate reference system of the `bbox` parameter. Default is WGS84 longitude/latitude.

_Maturity: `STABLE`_

# components.parameters.datetime.description
Either a date-time or an interval. Date and time expressions adhere to RFC 3339.
Intervals may be bounded or half-bounded (double-dots at start or end).
Examples:

* A date-time: "2018-02-12T23:20:50Z"
* A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
* Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

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

_Maturity: `STABLE`_

# components.parameters.datetime.schema.description
Either a date-time or an interval. Date and time expressions adhere to RFC 3339.
Intervals may be bounded or half-bounded (double-dots at start or end).
Examples:

* A date-time: "2018-02-12T23:20:50Z"
* A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
* Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

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

# components.parameters.filter.description
Filter features in the collection using the query expression in the parameter value. Filter expressions are written in the [Common Query Language (CQL2)](https://docs.ogc.org/is/21-065r2/21-065r2.html), which is an OGC Standard.

The recommended language for this query parameter is CQL2 Text (`filter-lang=cql2-text`).

CQL2 Text expressions are similar to SQL expressions and also support spatial, temporal and array predicates. All property references must be queryables of the collection and must be declared in the Queryables sub-resource of the collection.

The following are examples of CQL Text expressions:

* Logical operators (`AND`, `OR`, `NOT`) are supported
* Simple comparison predicates (`=`, `<>`, `<`, `>`, `<=`, `>=`):
  * `address.LocalityName = 'Bonn'`
  * `measuredHeight > 10`
  * `storeysAboveGround <= 4`
  * `creationDate > DATE('2017-12-31')`
  * `creationDate < DATE('2018-01-01')`
  * `creationDate >= DATE('2018-01-01') AND creationDate <= DATE('2018-12-31')`
* Advanced comparison operators (`LIKE`, `BETWEEN`, `IN`, `IS NULL`):
  * `name LIKE '%Kirche%'`
  * `measuredHeight BETWEEN 10 AND 20`
  * `address.LocalityName IN ('Bonn', 'Köln', 'Düren')`
  * `address.LocalityName NOT IN ('Bonn', 'Köln', 'Düren')`
  * `name IS NULL`
  * `name IS NOT NULL`
* Spatial operators (the standard Simple Feature operators, e.g., `S_INTERSECTS`, `S_WITHIN`):
  * `S_INTERSECTS(bbox, POLYGON((8 52, 9 52, 9 53, 8 53, 8 52)))`
* Temporal operators (e.g., `T_AFTER`, `T_BEFORE`, `T_INTERSECTS`)
  * `T_AFTER(creationDate, DATE('2018-01-01'))`
  * `T_BEFORE(creationDate, DATE('2018-01-01'))`
  * `T_INTERSECTS(creationDate, INTERVAL('2018-01-01','2018-12-31'))`
  * `T_INTERSECTS(INTERVAL(begin,end), INTERVAL('2018-01-01','2018-12-31'))`

_Maturity: `STABLE`_

# components.parameters.filter-crs.description
Specify which of the supported CRSs to use to encode geometric values in a filter expression (parameter 'filter'). Default is WGS84 longitude/latitude.

_Maturity: `STABLE`_

# components.parameters.filter-lang.description
Language of the query expression in the 'filter' parameter. Supported are 'cql2-text' (default) and 'cql2-json', specified in the [OGC Standard 'Common Query Language (CQL2)'](https://docs.ogc.org/is/21-065r2/21-065r2.html). 'cql2-text' is an SQL-like text encoding for filter expressions that also supports spatial, temporal and array predicates. 'cql2-json' is a JSON encoding of that grammar, suitable for use as part of a JSON object that represents a query. The use of 'cql2-text' is recommended for filter expressions in the 'filter' parameter.

_Maturity: `STABLE`_

# components.parameters.limitFeatures_vineyards.description
The optional limit parameter limits the number of items that are presented in the response document. If more items are selected, only the number of items as specified with the limit parameter are included in the response document. That is, the results is provided in pages ('paging'). Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items are not counted. If the value is higher than the maximum value, the maximum value is used instead of the parameter value.
If no parameter value is provided, the default value applies. If more items are available, a link to the next page with more results is provided with the response (link relation type: 'next'). To avoid receiving the result in pages, try to set the limit parameter to the maximum value.

_Maturity: `STABLE`_

# components.parameters.offsetFeatures.description
The optional offset parameter identifies the index of the first feature in the response in the overall result set.

_Maturity: `STABLE`_

# components.parameters.offsetFeatures.schema.description
The optional offset parameter identifies the index of the first feature in the response in the overall result set.

# components.parameters.q.description
General text search in multiple text properties of the data. Separate search terms by comma.If at least one of the search terms is included in an item, it is included in the result set.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.resultTypeFeatures.description
One of `hits` and `items`. `items` returns the features, `hits` returns no features, but only the information about the number features matched by the request. For feature formats that do not support returning the number of matched features, `hits` will be rejected. `hitsOnly` is a deprecated alias for `hits`.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.sortby_vineyards.description
Sort the results based on the properties identified by this parameter. The parameter value is a comma-separated list of property names that can be used to sort results (sortables), where each parameter name may be preceeded by a '+' (ascending, default) or '-' (descending).

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.registerId_vineyards.description
Filter the collection by property 'registerId' (Vineyard register number).

_Maturity: `STABLE`_

# components.parameters.name_vineyards.description
Filter the collection by property 'name' (Vineyard name).

_Maturity: `STABLE`_

# components.parameters.region_vineyards.description
Filter the collection by property 'region' (Wine-growing region).

_Maturity: `STABLE`_

# components.parameters.subregion_vineyards.description
Filter the collection by property 'subregion' (Sub-region (Bereich)).

_Maturity: `STABLE`_

# components.parameters.cluster_vineyards.description
Filter the collection by property 'cluster' (Vineyard cluster (Großlage)).

_Maturity: `STABLE`_

# components.parameters.village_vineyards.description
Filter the collection by property 'village' (Village(s)).

_Maturity: `STABLE`_

# components.parameters.searchfield1_vineyards.description
Filter the collection by property 'searchfield1' (Search field (option 1)).

_Maturity: `STABLE`_

# components.parameters.searchfield2_vineyards.description
Filter the collection by property 'searchfield2' (Search field (option 2)).

_Maturity: `STABLE`_

# components.parameters.date_vineyards.description
Filter the collection by property 'date' (Validity date).

_Maturity: `STABLE`_

# components.parameters.fQueryables.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.profileQueryables_vineyards.description
Select the profiles to be used in the response. If no value is provided, the default profiles will be used.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fSortables.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.profileSortables_vineyards.description
Select the profiles to be used in the response. If no value is provided, the default profiles will be used.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fSchema.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.profileSchema_vineyards.description
Select the profiles to be used in the response. If no value is provided, the default profiles will be used.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fTileSets.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.tileMatrixSetIdTiles.description
The local identifier of a tile matrix set, unique within the API.

_Maturity: `STABLE`_

# components.parameters.fTileSet.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.tileCol.description
Column index of the tile on the selected zoom level. See http://www.maptiler.org/google-maps-coordinates-tile-bounds-projection/ for more information about Level, Row and Column in the Google Maps tiling scheme (WebMercatorQuad). Example: In the WebMercatorQuad tiling scheme Ireland is fully within the tile with the following values: Level 5, Row 10 and Col 15

_Maturity: `STABLE`_

# components.parameters.tileMatrix.description
Zoom level of the tile. See http://www.maptiler.org/google-maps-coordinates-tile-bounds-projection/ for more information about Level, Row and Column in the Google Maps tiling scheme (WebMercatorQuad). Example: In the WebMercatorQuad tiling scheme Ireland is fully within the tile with the following values: Level 5, Row 10 and Col 15

_Maturity: `STABLE`_

# components.parameters.tileRow.description
Row index of the tile on the selected zoom level. See http://www.maptiler.org/google-maps-coordinates-tile-bounds-projection/ for more information about Level, Row and Column in the Google Maps tiling scheme (WebMercatorQuad). Example: In the WebMercatorQuad tiling scheme Ireland is fully within the tile with the following values: Level 5, Row 10 and Col 15

_Maturity: `STABLE`_

# components.parameters.collections.description
The collections that should be included. The parameter value is a comma-separated list of collection names.

_Maturity: `STABLE`_

# components.parameters.fTileDataset.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.collectionIdTiles.description
The local identifier of a feature collection.

_Maturity: `STABLE`_

# components.parameters.exclude-properties.description
The properties that should be excluded for each feature. The parameter value is a comma-separated list of property names. By default, all feature properties with a value are returned. The parameter must not be used together with the 'properties' parameter.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fTileCollection.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.limitTile.description
The optional limit parameter limits the number of features that are included in the tile.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.properties.description
The properties that should be included for each feature. The parameter value is a comma-separated list of property names. By default, all feature properties with a value are returned.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fTileMatrixSets.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `STABLE`_

# components.parameters.tileMatrixSetIdTileMatrixSets.description
The local identifier of a tile matrix set, unique within the API.

_Maturity: `STABLE`_

# components.parameters.fStyles.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.styleId.description
The local identifier of a style, unique within the API.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.fStyle.description
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.

_Maturity: `PRELIMINARY` (the parameter may change in this API)_

# components.parameters.tileMatrixSetStyle.description
The tile matrix set that should be used by the style. The query parameter only applies to MapLibre/MapBox styles. The style source will be adjusted to the tile set for the selected tile matrix set. In addition, level expressions will be adjusted, if the levels of the tile matrix set differ from the levels in the WebMercatorQuad tile matrix set. Only supported for tile matrix sets that use a quad tree (e.g., WebMercatorQuad, WorldMercatorWGS84Quad, AdV_25832, and AdV_25833) and only for tile sets that are available in one of the tile matrix sets.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.parameters.collectionIdStyles.description
The local identifier of a feature collection.

_Maturity: `PRELIMINARY` (specified in a draft standard; the parameter may change in this API)_

# components.headers.Content-Bounding-Box.description
The bounding box of the coordinates in the response. The coordinates are in the coordinate reference system provided in the 'Content-Crs' header. The header is only provided, if the response is not streamed.

_Maturity: `PRELIMINARY` (the header may change in this API)_

# components.headers.ContentCrsFeatures.description
The coordinate reference system of coordinates in the response.

_Maturity: `STABLE`_

# components.headers.Content-Temporal-Extent.description
The temporal extent of the features in the response. The values are seconds since epoch. The header is only provided, if the response is not streamed.

_Maturity: `PRELIMINARY` (the header may change in this API)_

# components.headers.LinkInResponse.description
Links associated with the resource in the response. See RFC 8288 for the syntax.

_Maturity: `STABLE`_