Allgemeine Einführung

Für die Nachnutzung in Systemen existiert eine Beschreibung der programmatischen Aufrufe, z.B. für umwelt.info
Sie können alle Filterelemente, wie sie auf der Rechercheseite gezeigt werden, wie z.B. Produkte, auch über die API abrufen. Der Ausgangs-URL für eine Abfrage der Reporting Elemente lautet: POST auf https://www.wasser-de.de/rest/api/reportingelement mit den im Folgenden beschriebenen Filtern im Body.

Aufruf von Filterelementen

Richtlinie

Filter	Befehl
Richtlinie	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" #"}]}]}}
Beispiel: WRRL	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" 1#"}]}]}}

Diese Abfrage setzt den Filter für eine bestimmte Richtlinie und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/richtlinie. Aufgrund des Datenbanksystems ist in diesem Fall (und z.T. auch in anderen Filterelementen unten) die Angabe der # wichtig

Zyklus

Filter	Befehl
Zyklus	{"filter":{"and":[{"or":[{"col":"ZYKLUS_ID","op":"locate","value":" #"}]}]}}
Beispiel: 2009-2015	{"filter":{"and":[{"or":[{"col":"ZYKLUS_ID","op":"locate","value":" 1#"}]}]}}

Diese Abfrage setzt den Filter für einen bestimmten Zyklus und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/zyklus.

Zuständigkeit

Filter	Befehl
Zuständigkeit	{"filter":{"and":[{"or":[{"col":"SOURCE_ID","op":"locate","eq":" "}]}]}}
Beispiel: FGG Donau	{"filter":{"and":[{"or":[{"col":"SOURCE_ID","op":"locate","eq":" 23"}]}]}}

Diese Abfrage setzt den Filter für eine bestimmte Zuständigkeit und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/zustaendigkeit.

Gebiet

Filter	Befehl
Gebiet	{"filter":{"and":[{"or":[{"col":"REGION_ID","op":"locate","eq":" "}]}]}}
Beispiel: Elbe	{"filter":{"and":[{"or":[{"col":"REGION_ID","op":"locate","eq":" 19"}]}]}}

Diese Abfrage setzt den Filter für ein bestimmtes Gebiet und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/gebiet.

Produkt

Filter	Befehl
Produkt	{"filter":{"and":[{"or":[{"col":"REPORTING_TYPE_ID","op":"locate","value":" #"}]}]}}
Beispiel: Rechtsgrundlagen	{"filter":{"and":[{"or":[{"col":"REPORTING_TYPE_ID","op":"locate","value":" 6#"}]}]}}

Diese Abfrage setzt den Filter für ein bestimmtes Produkt und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/produkt.

Lizenz

Filter	Befehl
Lizenz	{"filter":{"and":[{"or":[{"col":"LICENSE_ID","op":"locate","value":" "}]}]}}
Beispiel: CC BY	{"filter":{"and":[{"or":[{"col":"LICENSE_ID","op":"locate","value":" 2"}]}]}}

Diese Abfrage setzt den Filter für eine bestimmte Lizenz und liefert die passende Ergebnisliste. Ausgabe der möglichen Werte: GET auf https://www.wasser-de.de/rest/api/lizenz.

Kombination von Filterelementen

Filter	Befehl
Richtlinie,Produkt	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" #"}]}, {"or":[{"col":"REPORTING_TYPE_ID","op":"locate","value":" #"}]}]}}
Beispiel: WRRL und Rechtsgrundlagen	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" 1#"}]}, {"or":[{"col":"REPORTING_TYPE_ID","op":"locate","value":" 6#"}]}]}}

Diese Abfrage setzt die Filter für eine Kombination an Filterelementen und liefert die passende Ergebnisliste. Die logische Verknüpfung erfolgt über "and" oder "or". Dem logischen Operator folgt ein Array von Angaben in geschweiften Klammern, die kommasepariert aneinandergrenzen. Jede dieser Angaben kann sich in sich wiederum auch aus logischen Verknüpfungen zusammensetzen. Maximale Filterkombination: Keine Begrenzung bei der Anzahl der Filterelemente oder der Tiefe der Filterung.

Meilensteinprodukte der Timeline

Die Meilensteindokumente der Wasser-DE Timeline erhalten Sie über einen GET Befehl auf https://www.wasser-de.de/rest/api/meilensteine

Volltextsuche

Filter	Befehl
Richtlinie,Volltextsuche	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" #"}]}, {"or":[{"col":"QUERY","op":"locate","value":" #"}]}]}}
Beispiel: WRRL und Stoffliste	{"filter":{"and":[{"or":[{"col":"RICHTLINIE_IDS","op":"locate","value":" 1#"}]}, {"or":[{"col":"QUERY","op":"locate","value":"Stoffliste"}]}]}}

Diese Abfrage setzt den Filter auf eine Kombination an Filterelementen und der Eingabe eines Freitexts in der Volltextsuche. Die logische Verknüpfung zwischen den Filterelementen und der Freitexteingabe erfolgt mit AND. In der Volltextsuche können sowohl vordefinierte Filter eingegeben oder per Freitext gesucht werden. Der Freitext durchsucht den Titel und den Inhalt des verlinkten Dokuments

Anleitung zum Aufrufen der API in der Kommandozeile (Anwendungsfall Firefox)

· Webseite Wasser-DE ansteuern. Achtung: Bitte die Domäne wasser-de.de verwenden: https://www.wasser-de.de

· Klick auf "Recherche" und Öffnen der Suche

· Öffnen der Konsole (F12) und dann die Netzwerkanalyse. In der Kopfleiste "Alles" einstellen

· Anklicken eines beliebigen Filters, z.B. Richtlinie: WRRL

· In der Auflistung der Netzwerkanalyse erscheint die Datei "V_REP_BASE_VALID". Dort per Rechtsklick auf "Erneut senden" klicken

· Es öffnet sich links ein neues Fenster. Bei POST folgenden URL eingeben: https://www.wasser-de.de/rest/api/reportingelement. Dadurch liegen dann die passenden Voreinstellungen vor

· Bei "Inhalt" muss anschließend folgendes Filter-Statement eingegeben werden, um alle Reporting-Elemente zu erhalten: {"filter":{"and":[{"or":[]}]}}. Wenn spezifische Filter gesetzt werden sollen, dann bitte die Anleitung unten weiter befolgen. Anschließend auf "Senden" klicken.

· Unter "Datei" wird der Request unten neu aufgelistet. Beim Klick auf diesen Request öffnet sich rechts ein neues Fenster. Dort kann die Performance und das Ergebnis angeschaut werden. Unter "Antwort" wird die Ergebnisliste angezeigt.