Package: de-pegel-online
pegel-onlineAPI für das bundesweite Messstellennetz der Wasserstraßen- und Schifffahrtsverwaltung des Bundes.Die API stellt drei verschiedene Ressourcen zur Verfügung:Station,Measurement,Water.Authentifizierung / Autorisierung / API LimitierungEs ist keine Authentifizierung oder Autorisierung notwendig. Aktuell besteht keine API Limitierung.Allgemeine Query-ParameterZusätzlich zu den angegebenen Parametern sind ebenfalls allgemeine Parameter für alle Schnittstellen verfügbar (Dokumentation).charset: Gibt die Kodierung der Response an. Standard ist hierUTF-8. Möglich ist z.B. auchISO-8859-1.prettyprint: Kann die zur besseren Lesbarkeit standardmäßig aktivierte Teilung der Response in mehreren Zeilen deaktivieren:prettyprint=false. Diese Einstellung wird für den produktiven Einsatz empfohlen.limit/offset: Einschränkung der Anzahl der Ergebnisse. Hiermit kann 'Pagination' realisiert werden.limitgibt dabei die Anzahl der zurückgegebenen Elemente an.offsetermöglicht einen Offset vom Startwert. Beispiel:limit=10&offset=20bedeutet, dass 10 Elemente beginnend mit dem 21. Element zurückgegeben werden.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.0Package version: 0.1.1Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visithttps://www.pegelonline.wsv.de/Requirements.Python >= 3.6Installation & Usagepip installpipinstalldeutschland[pegel_online]poetry installpoetryadddeutschland-Epegel_onlineSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)UsageImport the package:fromdeutschlandimportpegel_onlineGetting StartedPlease follow theinstallation procedureand then run the following:importtimefromdeutschlandimportpegel_onlinefrompprintimportpprintfromdeutschland.pegel_online.apiimportmeasurement_apifromdeutschland.pegel_online.model.measurement_resultimportMeasurementResultfromdeutschland.pegel_online.model.timeseries_not_foundimportTimeseriesNotFound# Defining the host is optional and defaults to https://www.pegelonline.wsv.de/webservices/rest-api/v2# See configuration.py for a list of all supported configuration parameters.configuration=pegel_online.Configuration(host="https://www.pegelonline.wsv.de/webservices/rest-api/v2")# Enter a context with an instance of the API clientwithpegel_online.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=measurement_api.MeasurementApi(api_client)station="593647aa-9fea-43ec-a7d6-6476a76ae868"# str | UUID / Name / Pegelnummer der Station.timeseries="W"# str | timeseries shortnamestart="2022-02-06T09:00:00+01:00"# str | Zeitpunkt codiert im [ISO_8601](https://de.wikipedia.org/wiki/ISO_8601) Format. Angabe eines Datums oder einer Period (_P_, z.B. 'P8D' für die Messwerte der letzten 8 Tage) sind möglich. (optional)end=""# str | Endzeitpunkt codiert im [ISO_8601](https://de.wikipedia.org/wiki/ISO_8601) Format. Kann auch leer gelassen werden, dann wird automatisch der aktuelle Zeitstempel verwendet. (optional)try:# Zugriff auf die Ressource Measurementapi_response=api_instance.get_measurement_by_station(station,timeseries,start=start,end=end)pprint(api_response)exceptpegel_online.ApiExceptionase:print("Exception when calling MeasurementApi->get_measurement_by_station:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://www.pegelonline.wsv.de/webservices/rest-api/v2ClassMethodHTTP requestDescriptionMeasurementApiget_measurement_by_stationGET/stations/{station}/{timeseries}/measurements.jsonZugriff auf die Ressource MeasurementMeasurementApiget_measurement_diagram_by_stationGET/stations/{station}/{timeseries}/measurements.pngZugriff auf die Ressource Measurement - Rückgabe als Diagramm (PNG)StationApiget_stationsGET/stations.jsonÜbersicht über alle Stationen (Pegel)StationApiget_stations_by_idGET/stations/{station}.jsonZugriff auf eine bestimmte Station (Pegel)WaterApiget_current_measurment_by_stationGET/stations/{station}/{timeseries}.jsonZugriff auf eine TimeseriesWaterApiget_watersGET/waters.jsonZugriff auf die Ressource WaterDocumentation For ModelsCommentCommentInnerCurrentMeasurementMeasurementResultMeasurementResultInnerStationStationOverviewResultStationWaterTimeseriesTimeseriesGaugeZeroTimeseriesNotFoundWaterResultDocumentation For AuthorizationAll endpoints do not require authorization.Authorkontakt@bund.devNotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in pegel_online.apis and pegel_online.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.pegel_online.api.default_api import DefaultApifrom deutschland.pegel_online.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
from deutschland import pegel_online
from deutschland.pegel_online.apis import *
from deutschland.pegel_online.models import *