mudab

October 9, 2021 · View on GitHub

Meeres-Monitoringdaten von Küstenbundesländern und Forschungseinrichtungen

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bundesAPI/deutschland.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bundesAPI/deutschland.git)

Then import the package:

from deutschland import mudab

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

from deutschland import mudab

Getting Started

Please follow the installation procedure and then run the following:


import time
from deutschland import mudab
from pprint import pprint
from deutschland.mudab.api import default_api
from deutschland.mudab.model.filter_request import FilterRequest
from deutschland.mudab.model.inline_response200 import InlineResponse200
from deutschland.mudab.model.inline_response2001 import InlineResponse2001
from deutschland.mudab.model.inline_response2002 import InlineResponse2002
from deutschland.mudab.model.inline_response2003 import InlineResponse2003
from deutschland.mudab.model.inline_response2004 import InlineResponse2004
from deutschland.mudab.model.inline_response2005 import InlineResponse2005
from deutschland.mudab.model.inline_response2006 import InlineResponse2006
from deutschland.mudab.model.inline_response2007 import InlineResponse2007
from deutschland.mudab.model.inline_response2008 import InlineResponse2008
# Defining the host is optional and defaults to https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements
# See configuration.py for a list of all supported configuration parameters.
configuration = mudab.Configuration(
    host = "https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements"
)



# Enter a context with an instance of the API client
with mudab.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    filter_request = FilterRequest(
        filter=Filter(
            _or=FilterAction(
                col="col_example",
                op="op_example",
                value="value_example",
            ),
            _and=FilterAction(
                col="col_example",
                op="op_example",
                value="value_example",
            ),
        ),
        range=Range(
            _from=1,
            count=1,
        ),
        orderby=Orderby(
            col="col_example",
            dir="asc",
        ),
    ) # FilterRequest |  (optional)

    try:
        # Liste aller Messstationen
        api_response = api_instance.list_mess_stationen(filter_request=filter_request)
        pprint(api_response)
    except mudab.ApiException as e:
        print("Exception when calling DefaultApi->list_mess_stationen: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://geoportal.bafg.de/MUDABAnwendung/rest/BaseController/FilterElements

ClassMethodHTTP requestDescription
DefaultApilist_mess_stationenPOST /STATION_SMALLListe aller Messstationen
DefaultApilist_parameterPOST /MV_PARAMETERListe aller Parameter
DefaultApilist_parameter_valuesPOST /MV_STATION_MSMNTListe aller Messwerte
DefaultApilist_parameters_biologiePOST /MV_PARAMETER_BIOLOGIEListe aller Parameter im Biologie Kompartiment
DefaultApilist_parameters_biotaPOST /MV_PARAMETER_BIOTAListe aller Parameter im Biota Kompartiment
DefaultApilist_parameters_sedimentPOST /MV_PARAMETER_SEDIMENTListe aller Parameter im Sediment Kompartiment
DefaultApilist_parameters_wasserPOST /MV_PARAMETER_WASSERListe aller Parameter im Wasser Kompartiment
DefaultApilist_plc_stationsPOST /V_PLC_STATIONListe aller HELCOM PLC Stationen
DefaultApilist_projekt_stationenPOST /PROJECTSTATION_SMALLListe aller Projekt Stationen

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in mudab.apis and mudab.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from deutschland.mudab.api.default_api import DefaultApi
  • from deutschland.mudab.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
from deutschland import mudab
from deutschland.mudab.apis import *
from deutschland.mudab.models import *