dmi_open_data.climatedata.ClimateDataStationValuesApi¶
All URIs are relative to https://dmigw.govcloud.dk
| Method | HTTP request | Description |
|---|---|---|
| get_station_value_by_id | GET /v2/climateData/collections/stationValue/items/{id} | Get station value with id |
| get_station_values | GET /v2/climateData/collections/stationValue/items | Get station values |
get_station_value_by_id¶
Feature get_station_value_by_id(id)
Get station value with id
Example¶
- Api Key Authentication (api-key):
import dmi_open_data.climatedata
from dmi_open_data.climatedata.models.feature import Feature
from dmi_open_data.climatedata.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.climatedata.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.climatedata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dmi_open_data.climatedata.ClimateDataStationValuesApi(api_client)
id = 'id_example' # str |
try:
# Get station value with id
api_response = api_instance.get_station_value_by_id(id)
print("The response of ClimateDataStationValuesApi->get_station_value_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ClimateDataStationValuesApi->get_station_value_by_id: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str |
Return type¶
Authorization¶
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/geo+json, application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Operation | - |
| 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 \"} | - |
| 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 \"} | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_station_values¶
FeatureCollection get_station_values(station_id=station_id, datetime=datetime, parameter_id=parameter_id, sortorder=sortorder, time_resolution=time_resolution, qc_status=qc_status, validity=validity, limit=limit, offset=offset, bbox=bbox, bbox_crs=bbox_crs)
Get station values
Example¶
- Api Key Authentication (api-key):
import dmi_open_data.climatedata
from dmi_open_data.climatedata.models.feature_collection import FeatureCollection
from dmi_open_data.climatedata.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.climatedata.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.climatedata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dmi_open_data.climatedata.ClimateDataStationValuesApi(api_client)
station_id = 'station_id_example' # str | Filter by stationId (optional)
datetime = '../2018-03-18T12:31:12Z' # str | datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime and dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339. Will filter to only include station values which starts within the specified time interval. Both the upper and lower limit is inclusive.<br/>As an illustrative example, if you asked for the interval 2004-03-12T14:00:00Z - 2004-04-14:15:00:00Z you would get:<ul> <li>All hour station values in the range</li> <li>All day values from 2004-03-13 until and including 2004-04-14. Day values for 2004-03-12 is excluded because 14:00:00Z is after the start of the day for any parameter/station combination.</li> <li>The month values for 2004-04, because they starts sometime around 2004-04-01 depending on parameter and timezone the station is located in</li></ul> (optional)
parameter_id = 'parameter_id_example' # str | Filter by parameterId - see parameter list <a href=\"https://opendatadocs.dmi.govcloud.dk/en/Data/Climate_Data#parameters\">here</a> (optional)
sortorder = 'sortorder_example' # str | Ordering of returned results. Default is unsorted (optional)
time_resolution = 'time_resolution_example' # str | Filter by time resolution (hour/day/month/year), ie. what type of time interval the station value represents (optional)
qc_status = 'qc_status_example' # str | Filter by qcStatus (optional)
validity = True # bool | Filter by validity which can be true or false. (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 station values 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 station values
api_response = api_instance.get_station_values(station_id=station_id, datetime=datetime, parameter_id=parameter_id, sortorder=sortorder, time_resolution=time_resolution, qc_status=qc_status, validity=validity, limit=limit, offset=offset, bbox=bbox, bbox_crs=bbox_crs)
print("The response of ClimateDataStationValuesApi->get_station_values:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ClimateDataStationValuesApi->get_station_values: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| station_id | str | Filter by stationId | [optional] |
| datetime | str | datetime searching as specified in https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_parameter_datetime and dates as specified in RFC3339 https://tools.ietf.org/html/rfc3339. Will filter to only include station values which starts within the specified time interval. Both the upper and lower limit is inclusive.<br/>As an illustrative example, if you asked for the interval 2004-03-12T14:00:00Z - 2004-04-14:15:00:00Z you would get:<ul> <li>All hour station values in the range</li> <li>All day values from 2004-03-13 until and including 2004-04-14. Day values for 2004-03-12 is excluded because 14:00:00Z is after the start of the day for any parameter/station combination.</li> <li>The month values for 2004-04, because they starts sometime around 2004-04-01 depending on parameter and timezone the station is located in</li></ul> | [optional] |
| parameter_id | str | Filter by parameterId - see parameter list <a href=\"https://opendatadocs.dmi.govcloud.dk/en/Data/Climate_Data#parameters\">here</a> | [optional] |
| sortorder | str | Ordering of returned results. Default is unsorted | [optional] |
| time_resolution | str | Filter by time resolution (hour/day/month/year), ie. what type of time interval the station value represents | [optional] |
| qc_status | str | Filter by qcStatus | [optional] |
| validity | bool | Filter by validity which can be true or false. | [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 station values 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¶
Authorization¶
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/geo+json, application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a feature collection of station values adhering to the query | - |
| 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 \"} | - |
| 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 \"} | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]