dmi_open_data.oceanobs.TidewaterApi¶

All URIs are relative to https://dmigw.govcloud.dk

Method	HTTP request	Description
get_station_by_id	GET /v2/oceanObs/collections/tidewaterstation/items/{id}	Get a single tidewater station
get_stations	GET /v2/oceanObs/collections/tidewaterstation/items	Get tidewater stations
get_tidewater	GET /v2/oceanObs/collections/tidewater/items	Get tidewater predictions
get_tidewater_by_id	GET /v2/oceanObs/collections/tidewater/items/{id}	Get a single tidewater prediction

get_station_by_id¶

Feature get_station_by_id(id)

Get a single tidewater station

Example¶

Api Key Authentication (api-key):

import dmi_open_data.oceanobs
from dmi_open_data.oceanobs.models.feature import Feature
from dmi_open_data.oceanobs.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dmigw.govcloud.dk
# See configuration.py for a list of all supported configuration parameters.
configuration = dmi_open_data.oceanobs.Configuration(
    host = "https://dmigw.govcloud.dk"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api-key
configuration.api_key['api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with dmi_open_data.oceanobs.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dmi_open_data.oceanobs.TidewaterApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get a single tidewater station
        api_response = api_instance.get_station_by_id(id)
        print("The response of TidewaterApi->get_station_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TidewaterApi->get_station_by_id: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	str

Return type¶

Feature

Authorization¶

api-key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successful Operation	-
5XX	Server Error - The server failed to fulfill an apparently valid request.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 500 or 507\", \"error\":\"the value of the HTTP response code phrase \"}	-
4XX	Client Error - The request contains bad syntax or cannot be fulfilled.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 400 or 404\", \"error\":\"the value of the HTTP response code phrase \"}	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stations¶

FeatureCollection get_stations(datetime=datetime, station_id=station_id, limit=limit, offset=offset, bbox=bbox, bbox_crs=bbox_crs)

Get tidewater stations

Example¶

Api Key Authentication (api-key):

import dmi_open_data.oceanobs
from dmi_open_data.oceanobs.models.feature_collection import FeatureCollection
from dmi_open_data.oceanobs.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dmigw.govcloud.dk
# See configuration.py for a list of all supported configuration parameters.
configuration = dmi_open_data.oceanobs.Configuration(
    host = "https://dmigw.govcloud.dk"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api-key
configuration.api_key['api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with dmi_open_data.oceanobs.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dmi_open_data.oceanobs.TidewaterApi(api_client)
    datetime = 'datetime_example' # str | NOTE - the parameter is added du to the OGC requirements, but no search restrictions are implemented.Datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime  an dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339 (optional)
    station_id = 'station_id_example' # str | Filter by stationId (optional)
    limit = 56 # int | Maximum number of results to return (optional)
    offset = 56 # int | number of results to skip before returning matching results (optional)
    bbox = [3.4] # List[float] | Select stations within bounding box. Southwesterly point (lon,lat) followed by northeasterly point (lon, lat) (optional)
    bbox_crs = 'https://www.opengis.net/def/crs/OGC/1.3/CRS84' # str | Which coordinate reference system to use. Only the CRS84 is supported (optional) (default to 'https://www.opengis.net/def/crs/OGC/1.3/CRS84')

    try:
        # Get tidewater stations
        api_response = api_instance.get_stations(datetime=datetime, station_id=station_id, limit=limit, offset=offset, bbox=bbox, bbox_crs=bbox_crs)
        print("The response of TidewaterApi->get_stations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TidewaterApi->get_stations: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
datetime	str	NOTE - the parameter is added du to the OGC requirements, but no search restrictions are implemented.Datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime an dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339	[optional]
station_id	str	Filter by stationId	[optional]
limit	int	Maximum number of results to return	[optional]
offset	int	number of results to skip before returning matching results	[optional]
bbox	List[float]	Select stations within bounding box. Southwesterly point (lon,lat) followed by northeasterly point (lon, lat)	[optional]
bbox_crs	str	Which coordinate reference system to use. Only the CRS84 is supported	[optional] [default to 'https://www.opengis.net/def/crs/OGC/1.3/CRS84']

Return type¶

FeatureCollection

Authorization¶

api-key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successful Operation	-
5XX	Server Error - The server failed to fulfill an apparently valid request.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 500 or 507\", \"error\":\"the value of the HTTP response code phrase \"}	-
4XX	Client Error - The request contains bad syntax or cannot be fulfilled.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 400 or 404\", \"error\":\"the value of the HTTP response code phrase \"}	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tidewater¶

FeatureCollection get_tidewater(datetime=datetime, station_id=station_id, prediction_type=prediction_type, limit=limit, offset=offset, sortorder=sortorder, bbox=bbox, bbox_crs=bbox_crs)

Get tidewater predictions

Example¶

Api Key Authentication (api-key):

import dmi_open_data.oceanobs
from dmi_open_data.oceanobs.models.feature_collection import FeatureCollection
from dmi_open_data.oceanobs.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dmigw.govcloud.dk
# See configuration.py for a list of all supported configuration parameters.
configuration = dmi_open_data.oceanobs.Configuration(
    host = "https://dmigw.govcloud.dk"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api-key
configuration.api_key['api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with dmi_open_data.oceanobs.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dmi_open_data.oceanobs.TidewaterApi(api_client)
    datetime = '../2018-03-18T12:31:12Z' # str | datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime  an dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339 (optional)
    station_id = 'station_id_example' # str | Filter by tidewaterStationId (optional)
    prediction_type = 'prediction_type_example' # str | Filter by predictionType (optional)
    limit = 56 # int | Maximum number of results to return (optional)
    offset = 56 # int | number of results to skip before returning matching results (optional)
    sortorder = 'sortorder_example' # str | Order by which to return results. Default is not sorted (optional)
    bbox = [3.4] # List[float] | Select tidewater within bounding box. Southwesterly point (lon,lat) followed by northeasterly point (lon, lat) (optional)
    bbox_crs = 'https://www.opengis.net/def/crs/OGC/1.3/CRS84' # str | Which coordinate reference system to use. Only the CRS84 is supported (optional) (default to 'https://www.opengis.net/def/crs/OGC/1.3/CRS84')

    try:
        # Get tidewater predictions
        api_response = api_instance.get_tidewater(datetime=datetime, station_id=station_id, prediction_type=prediction_type, limit=limit, offset=offset, sortorder=sortorder, bbox=bbox, bbox_crs=bbox_crs)
        print("The response of TidewaterApi->get_tidewater:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TidewaterApi->get_tidewater: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
datetime	str	datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime an dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339	[optional]
station_id	str	Filter by tidewaterStationId	[optional]
prediction_type	str	Filter by predictionType	[optional]
limit	int	Maximum number of results to return	[optional]
offset	int	number of results to skip before returning matching results	[optional]
sortorder	str	Order by which to return results. Default is not sorted	[optional]
bbox	List[float]	Select tidewater within bounding box. Southwesterly point (lon,lat) followed by northeasterly point (lon, lat)	[optional]
bbox_crs	str	Which coordinate reference system to use. Only the CRS84 is supported	[optional] [default to 'https://www.opengis.net/def/crs/OGC/1.3/CRS84']

Return type¶

FeatureCollection

Authorization¶

api-key

HTTP request headers¶

Content-Type: Not defined
Accept: application/geo+json, application/json

HTTP response details¶

Status code	Description	Response headers
200	Successful Operation	-
5XX	Server Error - The server failed to fulfill an apparently valid request.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 500 or 507\", \"error\":\"the value of the HTTP response code phrase \"}	-
4XX	Client Error - The request contains bad syntax or cannot be fulfilled.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 400 or 404\", \"error\":\"the value of the HTTP response code phrase \"}	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tidewater_by_id¶

Feature get_tidewater_by_id(id)

Get a single tidewater prediction

Example¶

Api Key Authentication (api-key):

import dmi_open_data.oceanobs
from dmi_open_data.oceanobs.models.feature import Feature
from dmi_open_data.oceanobs.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dmigw.govcloud.dk
# See configuration.py for a list of all supported configuration parameters.
configuration = dmi_open_data.oceanobs.Configuration(
    host = "https://dmigw.govcloud.dk"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api-key
configuration.api_key['api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with dmi_open_data.oceanobs.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dmi_open_data.oceanobs.TidewaterApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get a single tidewater prediction
        api_response = api_instance.get_tidewater_by_id(id)
        print("The response of TidewaterApi->get_tidewater_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TidewaterApi->get_tidewater_by_id: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	str

Return type¶

Feature

Authorization¶

api-key

HTTP request headers¶

Content-Type: Not defined
Accept: application/geo+json, application/json

HTTP response details¶

Status code	Description	Response headers
200	Successful Operation	-
5XX	Server Error - The server failed to fulfill an apparently valid request.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 500 or 507\", \"error\":\"the value of the HTTP response code phrase \"}	-
4XX	Client Error - The request contains bad syntax or cannot be fulfilled.<br/>The body will be structured using this format:<br/>{\"message\":\"the error message\", \"status\":\"the value of the HTTP response code, e.g. 400 or 404\", \"error\":\"the value of the HTTP response code phrase \"}	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]