{
"openapi": "3.0.2",
"info": {
"title": "Waldklimadaten",
"version": "2.0.82",
"description": "### Inhalt\nDie Schnittstelle stellt Messwerte für verschiedene **Messgrößen** verschiedener **Waldklimastationen** bereit.\n### Werte\nDie Daten liegen als **Tageswerte** und darauf aufbauend als **Monats**- und **Jahreswerte** vor. Stundenwerte gibt es nur für das letzte Quartal. Generell könnten deshalb im letzten Quartal alle Werte (egal, welche Aggregierung) auch ungeprüft sein. Es gibt aber keine Dopplung derart, dass ein Wert sowohl geprüft als auch ungeprüft ist. Sollten in den Daten, welche älter als 3 Monate (=historisch) sind, Fehler auftauchen, kann man diese mit der kompletten Aktualisierung der betreffenden Station korrigieren.\n### Aggregierungen\nDie Herleitung der Aggregierung ist in den Vorgaben bezüglich der Anzahl der Werte für die entsprechende Aggregierung ersichtlich. Die Frage nach dem Zeitbereich für die Aggegierung stellt sich nur für die Stundenwerte, d.h., der Wert für die angezeigte Stunde resultiert aus Messwerten der vergangenen 59min. Die Berechnung für die Aggreagtionen erfolgt in den Morgenstunden bis 6 Uhr. Die angefallenen Messdaten des aktuellen Tages werden nicht aggregiert und nicht ausgegeben.\n### Nutzunglizenz\nDatenlizenz Deutschland – Namensnennung – Version 2.0 (DL-DE->BY-2.0)
https://www.govdata.de/dl-de/by-2-0\n### Service-Anbieter\nStaatsbetrieb Sachsenforst
Geschäftsleitung
Bonnerwitzer Str. 34
01796 Pirna
\nInhaltlich zuständiges Fachreferat: Referat 46 Waldentwicklung/Waldschutz
Technischer Betrieb: Referat 34 Fach-Informationssysteme\n",
"contact": {
"name": "Service Desk Sachsenforst",
"email": "sbs.servicedesk@smekul.sachsen.de"
}
},
"servers": [
{
"url": "http://sbs-waldklima.sachsenforst.smul.sachsen.de/api/",
"description": "Systemumgebung für die Produktion für Zugriffe innerhalb des Sächsischen Verwaltungsnetzwerks (SVN)"
},
{
"url": "http://opendata.sachsenforst.de/waldklima/api/",
"description": "Systemumgebung für die Produktion für Zugiffe aus dem gesamten Internet"
}
],
"tags": [
{
"name": "Waldklimastationen",
"description": "Die Beschreibung der Lokalitäten der Waldklimastationen"
},
{
"name": "Aktuelle Waldklimadaten",
"description": "Aggregierte Messwerte deren Messzeitpunkt innerhalb der letzten 3 Monate stattfand. Die Daten können ungeprüft sein und können sich nachträglich ändern."
},
{
"name": "Geprüfte Waldklimadaten",
"description": "Aggregierte und Messwerte Daten deren Messzeitpunkt älter als 3 Monate ist."
}
],
"paths": {
"/contract/{format}": {
"get": {
"tags": [
"Schnittstelle"
],
"summary": "Liefert die Beschreibung für die Schnittstelle (den Servicevertrag).",
"description": "Liefert die Beschreibung (Vereinbarung) für die Schnittstelle.\n",
"parameters": [
{
"in": "path",
"name": "format",
"schema": {
"type": "string",
"enum": [
"",
"json",
"swagger"
]
},
"required": true
}
],
"responses": {
"200": {
"description": "Liefert ein Yaml-Dokument mit der Schnittstellenbeschreibung im OpenAPI-Format 3.0",
"content": {
"application/yaml": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/Waldklimastationen": {
"get": {
"summary": "Liefert ausgewählte Metadaten für alle Waldklimastationen.",
"description": "TODO\n",
"tags": [
"Waldklimastationen"
],
"responses": {
"200": {
"description": "Eine Liste mit allen Waldklimastationen.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Waldklimastation"
}
}
}
}
},
"400": {
"description": "Ungültige Syntax"
}
}
}
},
"/Klimadaten/Aktuell": {
"get": {
"summary": "Liefert aktuelle Stundenwerte für eine Waldklimastation (letzte Quartal).",
"description": "Liefert aktuelle, noch nicht geprüfte Stundenwerte für eine Waldklimastation. Diese Daten können sich ändern, da noch nicht geprüft. Es kann auf Waldklimastation und den Vortag gefiltert werden.\n",
"tags": [
"Aktuelle Waldklimadaten"
],
"parameters": [
{
"$ref": "#/components/parameters/Waldklimastation"
},
{
"$ref": "#/components/parameters/Vortag"
}
],
"responses": {
"200": {
"description": "Liefert eine Liste aller Eigenschaften für eine Waldklimastation.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wert"
}
}
}
}
},
"400": {
"description": "Ungültige Syntax"
}
}
}
},
"/Klimadaten/Historisch": {
"get": {
"summary": "Liefert geprüfte Tageswerte für eine Waldklimastation.",
"description": "Liefert geprüfte (historische) Tageswerte für eine Waldklimastation. Diese Daten sind unveränderlich. Es kann auf Waldklimastation gefiltert werden.\n",
"tags": [
"Geprüfte Waldklimadaten"
],
"parameters": [
{
"$ref": "#/components/parameters/Waldklimastation"
}
],
"responses": {
"200": {
"description": "Liefert eine Liste von Messwerten für eine Waldklimastation. Die Liste kann leer sein.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wert"
}
}
}
}
},
"400": {
"description": "Ungültige Syntax"
}
}
}
}
},
"components": {
"schemas": {
"Waldklimastation": {
"type": "object",
"description": "Die Merkmale der Waldklimastation.",
"required": [
"Nummer",
"Name",
"Kurzbezeichnung",
"GeografischerRaumbezug",
"Kategorie"
],
"properties": {
"Nummer": {
"type": "number",
"format": "integer",
"description": "Der eindeutige Identifikator der Waldklimastation.",
"example": 2007
},
"Name": {
"type": "string",
"nullable": false,
"description": "Der ausführliche Name, die Bezeichnung der Waldklimastation",
"example": "Zeughaus"
},
"Kurzbezeichnung": {
"type": "string",
"nullable": false,
"description": "Die abgeürzte Bezeichnung vom Namen der Wldklimastation",
"example": "zh"
},
"GeografischerRaumbezug": {
"type": "string",
"format": "WKT",
"description": "Beschreibung der geografischen Lage. Das Koordinatenreferenzsystem ist `ETRS89/UTM Zone 33N`. Das amtliche Lagebezugssystem der Arbeitsgemeinschaft der Vermessungsverwaltungen der Länder der Bundesrepublik Deutschland, Europäische Terrestrische Referenzsysstem 1989 (Referenzsystem).\n",
"example": "POINT(450156.0000 5641382.0000)"
},
"Beschreibung": {
"type": "string",
"description": "Die ausführliche Beschreibung",
"example": "Wildwiese ca. 1,6 ha"
},
"InbetriebnahmeZeitpunkt": {
"type": "string",
"format": "date-time",
"description": "Datum der Inbetriebnahme",
"example": "1998-09-10T11:00:00.007Z"
},
"Kategorie": {
"type": "string",
"description": "Die Kategorie der Waldklimastation: - `LEVEL2`: Forstliche Dauerbeobachtung - `Garten`: phänologischer Garten - `Waldgebiet`: repräsentatives Waldgebiet\n",
"enum": [
"LEVEL2",
"Garten",
"Waldgebiet"
],
"example": "LEVEL2"
},
"Ort": {
"type": "string",
"description": "Eine freie Beschreibung des Gebietes in dem die Waldklimastation liegt.",
"example": "NaP Sächsische Schweiz, Revier Zeughaus, Abt. 413"
},
"Messgroessen": {
"type": "array",
"description": "Eine Liste der Messgrössen.\n",
"items": {
"$ref": "#/components/schemas/Messgroesse"
}
}
}
},
"Messgroesse": {
"type": "object",
"description": "Die bereitgestellte Messgröße",
"required": [
"Id",
"Bezeichnung",
"Einheit",
"Beschreibung"
],
"properties": {
"Id": {
"type": "number",
"format": "integer",
"description": "Der eindeutige Identifizierer für die Messgröße als Ganzzahl.",
"example": 870
},
"Bezeichnung": {
"type": "string",
"example": "Niederschlag [mm] - Summe",
"description": "Die Bezeichnung des Parameters."
},
"Kurzbezeichnung": {
"type": "string",
"description": "Die Kurzbezeichnung, auch Kürzel, der Messgröße.\n",
"example": "RR"
},
"Einheit": {
"type": "string",
"example": "mm",
"description": "Die Maßeinheit des Parameters."
},
"Beschreibung": {
"type": "string",
"example": "Summe der Niederschlagsmenge innerhalb 24 Stunden in Millimeter.",
"description": "Die konkrete Beschreibung des Messparameters."
}
}
},
"Wert": {
"type": "object",
"description": "Ein Wert für eine Waldklimastation und eine Messgröße und eine Aggregation.",
"properties": {
"Datum": {
"type": "string",
"format": "date-time",
"description": "Das Datum in der Zeitzone UTC.",
"example": "2019-10-10T22:26:06.307Z"
},
"WaldklimastationNummer": {
"type": "number",
"format": "integer",
"description": "Die eindeutige Nummer der zugehörigen Waldklimastation.",
"example": 2007
},
"MessgroesseId": {
"type": "number",
"format": "integer",
"description": "Der eindeutige Identifizierer der zugehörigen Messgröße.",
"example": 870
},
"Aggregation": {
"type": "string",
"description": "Das Aggregationsniveau des Wertes: - 'sum': Summe - 'avg': Durchschnitt - 'min': Minimum - 'max': Maximum\n",
"enum": [
"sum",
"avg",
"max",
"min"
],
"example": "sum"
},
"AggregationStufe": {
"type": "number",
"format": "integer",
"description": "Die Aggregationstsufe des Messwertes: - '1': Jahr - '2': Monat - '4': Tag - '5': Stunde\n",
"enum": [
1,
2,
4,
5
],
"example": 5
},
"Referenz": {
"type": "string",
"description": "Die Referenz: - 'E': Einzelwert - 'M': langjähriges Monatsaggregat - 'J': langjähriges Jahresaggregat\n",
"example": "M",
"enum": [
"E",
"M",
"J"
]
},
"MessungenAnzahl": {
"type": "integer",
"format": "int32",
"description": "Anzahl der Messungen, die in der Aggreagtion verwendet werden.",
"example": 6
},
"Betrag": {
"type": "number",
"format": "double",
"description": "Der Betrag des Messwertes.\n",
"example": 10.9
}
}
}
},
"parameters": {
"Waldklimastation": {
"in": "query",
"name": "Waldklimastation",
"description": "Der Identifikator für die Waldklimastation.",
"required": false,
"example": 2007,
"schema": {
"type": "string"
}
},
"Vortag": {
"in": "query",
"name": "Vortag",
"description": "Die Markierung, Messdaten entweder für den Vortag 'Vortag=true' oder für das letzte Quartal 'Vortag=false' auszugeben. Sind keine Daten für den Vortag vorhanden, erfolgt die Filterung fuer den Vor-Vortag. Sind dafuer ebenfalls keine Daten vorhanden, wird eine leeres Objekt zurueck gegeben.\n",
"schema": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}