Helgoland API Documentation

foo bar foo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo barfoo bar

/

GET Available endpoints.

Responses

200 A collection of API endpoints

/search

GET A simple search.

A simple search over all resource’s labels over all available endpoints. Note that the searching respects the current locale being selected.

Parameters

Name In Description Type
q query Term which shall match (case insensitive) a resource's label String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String

Responses

200 A collection of search results

/platforms

GET Available Platforms

A collection of available platforms. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
geometryTypes query

The type of geometry based on WKT types.

 String
platformGeometries query

The platform’s geometry, either site for stationary platforms (or stations) or track for mobile platforms.

 Array of String
observedGeometries query

The platform’s observed geometry, either static for remote platforms observing fixed geometries or dynamic otherwise.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String
bbox query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used. The Box can be supplied as either as json Points or as GeoJSON bbox.

Alternative 1: json Points

json bbox={ "ll": { "type": "Point", "coordinates": [<x>,<y>] }, "ur": { "type": "Point", "coordinates": [<x>,<y>] } }

Alternative 2: GeoJSON bbox

json bbox=<minx>,<miny>,<maxx>,<maxy>

 String
near query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.

json near={ "center": { "type": "Point", "coordinates": [<x>,<y>] }, "radius":500 }

String

Responses

200 A collection of platforms
400 A query parameter does not match expected format
415 Media Item not supported

/platforms/{platformId}

GET Gets a particular platform

Full view of a platform instance. A platform encodes a POINT geometry which is the actual location for stationary platforms and the last detected location for mobile platforms.

Parameters

Name In Description Type
platformId path String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String

Responses

200 An expanded item
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/platforms/{platformId}/extras

GET Gets extra infos for platform

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each dataset.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
platformId path String
fields query Array of String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/stations

GET Available Stations

A collection of available stations. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String
bbox query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used. The Box can be supplied as either as json Points or as GeoJSON bbox.

Alternative 1: json Points

json bbox={ "ll": { "type": "Point", "coordinates": [<x>,<y>] }, "ur": { "type": "Point", "coordinates": [<x>,<y>] } }

Alternative 2: GeoJSON bbox

json bbox=<minx>,<miny>,<maxx>,<maxy>

 String
near query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.

json near={ "center": { "type": "Point", "coordinates": [<x>,<y>] }, "radius":500 }

String

Responses

200 A collection of stations
400 A query parameter does not match expected format
415 Media Item not supported

/stations/{stationId}

GET Gets a particular station

Full data view of a station. A station is a GeoJSON point geometry which encodes available metadata in its properties member.

Parameters

Name In Description Type
stationId path String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String

Responses

200 An expanded item
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/stations/{stationId}/extras

GET Gets extra infos for station

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each dataset.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
stationId path String
fields query Array of String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/datasets

GET Gets available datasets

A collection of available datasets. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
geometryTypes query

The type of geometry based on WKT types.

 String
platformGeometries query

The platform’s geometry, either site for stationary platforms (or stations) or track for mobile platforms.

 Array of String
observedGeometries query

The platform’s observed geometry, either static for remote platforms observing fixed geometries or dynamic otherwise.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String
bbox query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used. The Box can be supplied as either as json Points or as GeoJSON bbox.

Alternative 1: json Points

json bbox={ "ll": { "type": "Point", "coordinates": [<x>,<y>] }, "ur": { "type": "Point", "coordinates": [<x>,<y>] } }

Alternative 2: GeoJSON bbox

json bbox=<minx>,<miny>,<maxx>,<maxy>

 String
near query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.

json near={ "center": { "type": "Point", "coordinates": [<x>,<y>] }, "radius":500 }

String

Responses

200 A collection of datasets
400 A query parameter does not match expected format
415 Media Item not supported

/datasets/{datasetId}

GET Gets a particular dataset

Full view of a dataset instance. All relevant relations (parameters, unit, platform, etc.) are inlined. If any additional information is listed in the extras array member it can be retrieved via /datasets/{datasetId}/extras (see next).

Parameters

Name In Description Type
datasetId path String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/datasets/{datasetId}/extras

GET Gets extra infos for dataset

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each dataset.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
datasetId path String
fields query Array of String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/datasets/{datasetId}/{interval}

GET Gets extra infos for dataset

Returns a pre-rendered image of a dataset for the given interval. Allowed interval values are

  • lastDay.png
  • lastWeek.png
  • lastMonth.png

Datasets of type quantity can be pre-rendered by a regular task. If pre-rendering is enabled for a given datasets depends on the API provider as it is a configuration issue.

Parameters

Name In Description Type
datasetId path String
interval path String

Responses

200 A list of (selected) extra infos
404 In case no prerendered image available (or is currently being rendered)

/datasets/{datasetId}/data

GET Gets data of a dataset

Gets data for a given timespan filter. Implementations may limit the maximum amount of time intervals a client can query in one request.

What Mime-Types are supported depends on the valueType. For example quantity observations can be drawn as a timeseries chart (i.e. either image/png or application/pdf). Supported Mime-Types are listed for each valueType when querying /service/{serviceId}?valueTypes=all produces:

  • application/json
  • image/png
  • text/csv
  • application/pdf
  • application/zip

Data can be classified into result times if these differ from actual timestamp. For example, this is the case for forecast data which might re-calculate (different result times) a given timespan. The data can be grouped by using resultTimes parameter. When resultTimes parameter is missing, data of the oldest result is being returned.

Parameters

Name In Description Type
datasetId path String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
timespan query

An ISO8601 formatted period. Only backslash formatted values are supported.

 String
resultTimes query

Filter data which is available for different result times. Query /extras?fields=resultTimes beforehand to get a list of result times or add resultTimes=all to get all data classified by result time. In case of resultTime is missing from Query, those data will be returned which belongs to the oldest result time.

 Array

Responses

200 Data for a given `timespan` in a requested output format
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/timeseries

GET Gets available timeseries

A collection of timeseries (i.e. datasets of type quantity which have been observed at stationary, insitu platforms having a 0-dimensional (POINT) location geometry. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String
bbox query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used. The Box can be supplied as either as json Points or as GeoJSON bbox.

Alternative 1: json Points

json bbox={ "ll": { "type": "Point", "coordinates": [<x>,<y>] }, "ur": { "type": "Point", "coordinates": [<x>,<y>] } }

Alternative 2: GeoJSON bbox

json bbox=<minx>,<miny>,<maxx>,<maxy>

 String
near query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.

json near={ "center": { "type": "Point", "coordinates": [<x>,<y>] }, "radius":500 }

String

Responses

200 A collection of timeseries

/timeseries/{timeseriesId}

GET Gets a particular timeseries

Full view of a timeseries instance. All relevant relations (parameters, unit, station, etc.) are inlined. If any additional information is listed in the extras array member it can be retrieved via /datasets/{datasetId}/extras (see next).

For backward compatibility reasons metadata about renderingHints and statusIntervals are inlined here as well. However, those are listed within extra infos to make it consistent.

Parameters

Name In Description Type
timeseriesId path String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String

Responses

200 An expanded item
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/timeseries/{timeseriesId}/extras

GET Gets extra infos for timeseries

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each timeseries.

You can query just the ones you are interested in by appending the fieldsquery parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
timeseriesId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/timeseries/{timeseriesId}/getData

GET Gets data of a timeseries

Gets data for a given timespan filter. Implementations may limit the maximum amount of time intervals a client can query in one request.

This operation does only return data of quantity dataset types fromstationary, insitu platforms having a 0-dimensional location geometry (station). Supported Mime-Types are application/json, image/png, application/pdf, and text/csv.

Parameters

Name In Description Type
timeseriesId path String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
timespan query

An ISO8601 formatted period. Only backslash formatted values are supported.

 String
width query

If image/png is requested, width determines the width in pixels.

 Integer
height query

If image/png is requested, height determines the height in pixels.

 Integer
legend query

Indicates if a legend shall be rendered directly on the image output (if image/png shall be the output).

 Boolean
grid query Boolean
generalize query

Indicates that timeseries data shall be generalized. See generalization section for details.

 Boolean
format query

Controls the output format of raw timeseries data. This avoids converting between different data formats on client side which uses a 3rd party chart rendering API. Currently, supported formats

  • tvp Time value pairs (the default)

  • highcharts Highcharts series data format.

Refer to the Format section for detailed information how the formats will look like.

 String
base64 query

Indicates binary images shall be encoded to a base64 string on server side. This makes it easily possible to display images from JavaScript (you would need a byte parsing library otherwise).

Here is an example how to embed encoded base64 string

<img src='data:image/png;base64," + encodedString + "' />
Boolean

Responses

200 Data for a given `timespan` in a requested output format
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/geometries

GET A collection of available geometries

All available geometries instances. Possible geometry types are

  • site, i.e. stationary platform locations (fixed)

  • track, i.e. trajectories made by a mobile platform

  • static, i.e. a fixed geometry observed by a remote platform

  • dynamic, i.e. geometry observed by a remote platform which changes over time

Parameters

Name In Description Type
geometryTypes query

The type of geometry based on WKT types.

 String
platformGeometries query

The platform’s geometry, either site for stationary platforms (or stations) or track for mobile platforms.

 Array of String
observedGeometries query

The platform’s observed geometry, either static for remote platforms observing fixed geometries or dynamic otherwise.

 Array of String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String
bbox query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used. The Box can be supplied as either as json Points or as GeoJSON bbox.

Alternative 1: json Points

json bbox={ "ll": { "type": "Point", "coordinates": [<x>,<y>] }, "ur": { "type": "Point", "coordinates": [<x>,<y>] } }

Alternative 2: GeoJSON bbox

json bbox=<minx>,<miny>,<maxx>,<maxy>

 String
near query

Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.

json near={ "center": { "type": "Point", "coordinates": [<x>,<y>] }, "radius":500 }

String

Responses

200 A collection of geometries

/geometries/{geometryId}

GET Gets a particular geometry

Full view of a geometry instance. Encodes as full GeoJSON geometry.

Parameters

Name In Description Type
geometryId path String
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
crs query

The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of crs=EPSG:25832 to ETRS89/UTM zone 32N).

Per default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.

Please note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!

 String

Responses

200 An expanded item
400 A query parameter does not match expected format
404 Item not found
415 Media Item not supported

/services

GET Get available service instances

All available service instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of services

/services/{serviceId}

GET Gets an instance

Gets a service instance.

Depending on what dataset types are available, differing output formats are available. For example, image/png (render as chart) or application/pdf (generating a report).

Parameters

Name In Description Type
serviceId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/services/{serviceId}/extras

GET Gets extra infos for a service

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each service.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
serviceId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/categories

GET Gets available categories

All available category instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of categories

/categories/{categoryId}

GET Gets a catefory instance

Gets a category instance.

Parameters

Name In Description Type
categoryId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/categories/{categoryId}/extras

GET Gets extra infos for a category

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each category.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
categoryId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/phenomena

GET Get available phenomenon instances

All available phenomenon instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of phenomena

/phenomena/{phenomenonId}

GET Gets a phenomenon instance

Gets a phenomenon instance

Parameters

Name In Description Type
phenomenonId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/phenomena/{phenomenonId}/extras

GET Gets extra infos for a phenomenon

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each phemomenon.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
phenomenonId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/procedure

GET Get available procedure instances

All available procedure instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of procedures

/procedures/{procedureId}

GET Gets a procedure instance

Gets a procedure instance.

Parameters

Name In Description Type
procedureId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/procedures/{procedureId}/extras

GET Gets extra infos for a procedure

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each procedure.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
procedureId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/offerings

GET Get available offerings instances

All available offering instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of offerings

/offerings/{offeringId}

GET Gets an offering instance

Gets an offering instance.

Parameters

Name In Description Type
offeringId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/offerings/{offeringId}/extras

GET Gets extra infos for a phenomenon

Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the extras metadata field of each offering.

You can query just the ones you are interested in by appending the fields query parameter and passing a comma-separated value list to it.

Parameters

Name In Description Type
offeringId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported

/features

GET Get available feature instances

All available instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all.

Parameters

Name In Description Type
locale query

Specifies the language as ISO639 code. Subdivisions are respected by an _ , e.g. en_US for American English.

The REST-API should consider the following order to detect a locale

  • Accept-Language (e.g. header information)
  • locale parameter

A fallback language cannot be specified as it depends on the data of the service provider.

 String
expanded query

If true a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.

The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is false.

 Boolean
services query

All resources where the given service id does match. The single form (service) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
categories query

All resources where the given category id does match. The single form (category) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
phenomena query

All resources where the given phenomenon id does match. The single form (phenomenon) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
procedures query

All resources where the given procedure id does match. The single form (procedure) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
offerings query

All resources where the given offering id does match. The single form (offering) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platforms query

All resources where the given platform id does match.

 Array of String
stations query

All resources where the given station id does match. The single form (station) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.

 Array of String
platformTypes query

Filters the resources to get only those related to the platform type filter.

Allowed values are stationary, mobile, insitu, remote, all.

The default is stationary,insitu.

 Array of String
valueTypes query

Filters the resources to get only those related to the dataset type filter.

Allowed values are quantity, count, text, all or any other custom types given by the implementing backend.

The default is quantity.

 Array of String

Responses

200 A collection of features

/features/{featureId}

GET Gets an feature instance

Gets a feature instance.

Parameters

Name In Description Type
featureId path String

Responses

200 An expanded item
404 Item not found
415 Media Item not supported

/features/{featureId}/extras

GET Gets extra infos for a feature

All available feature instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to stationary, insitu platforms. To retrieve a full metadata view add platformTypes=all. Depending on the expanded parameter the collections items are compact or do inline full metadata.

Filter options help to focus on a particular set of items. Filter either by parameters or spatially.

Parameters

Name In Description Type
featureId path String
fields query Array of String

Responses

200 A list of (selected) extra infos
404 Item not found
415 Media Item not supported