Nutzung der DKAN-API

Datensätze, die als Open Data angeboten werden, können über einen Internetbrowser betrachtet und heruntergeladen werden. Einmal ausgewählte Datensätze können aber auch direkt über die bereitstehende DKAN-API abgerufen werden, sodass automatisierte Abfragen möglich sind. Die Programmierschnittstelle (API) ermöglicht damit neue Anwendungfelder, etwa eine aktuelle Datenverwendung auf anderen Internetseiten oder in Smartphone-Apps.

Dataset

Dieser Teil der API bezieht sich auf allgemeine Funktionen des Open-Data-Angebotes.

Der Aufruf der Funktionen ist stets identisch über http://geo.muelheim-ruhr.de/api/3/action/[Name der Funktion]. Der Platzhalter [Name der Funktion] wird mit einer der nachstehenden Funktionsnamen ersetzt. Die Rückgabe der API erfolgt im JSON-Format.

package_list

Abfrage der Liste aller Datensätze (Dataset).

Aufruf: https://geo.muelheim-ruhr.de/api/3/action/package_list

Rückgabetyp: List of Dictionaries

current_package_list_with_ressources

Abfrage, mit der alle Datensätze (Dataset) und die beinhaltenden Ressourcen abgefragt werden können.

Aufruf: https://geo.muelheim-ruhr.de/api/3/action/current_package_list_with_reso...

Rückgabetyp: List of Dictionaries

package_show

Abfrage der Metadaten eines Datensatzes und dessen Ressourcen. Die id entspricht dem eindeutigen Bezeichner des jeweiligen Datensatzes, im folgenden Beispiel dem der Baustellen.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/3/action/package_show?id=febdce6c-d4c8-...

Rückgabetyp: Dictionary

site_read

Abfrage, mit der die Erreichbarkeit der Schnittstelle überprüft werden kann.

Beispielaufruf: http://geo.muelheim-ruhr.de/api/3/action/site_read

Rückgabetyp: Boolean

Datastore

Zum jeweiligen „Datastore“ gelangt man über „Untersuche Daten“ beim entsprechenden Datensatz und dort den Reiter „Daten-API“.

Alle nachfolgenden Parameter lassen sich miteinander kombinieren.

fields

Soll das Ergebnis der Anfrage auf bestimmte Felder beschränkt werden, so ist dies unter Angabe des Parameters fields möglich. Die einzelnen Feldbezeichnungen werden durch ein Komma voneinander separiert. In nachfolgendem Beispiel werden nur die Felder „Strassenschluessel“und „Name“ aus der Straßenliste abgerufen.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/action/datastore/search.json?resource_i...

filters

Mithilfe des Parameters filters lässt sich eine Suche genauer einschränken als mit dem Parameter query. Im nachfolgenden Beispiel erfolgt nur der Abruf des Eintrags mit dem Namen Ruhrufer aus der Straßenliste.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/action/datastore/search.json?resource_i...

limit

Standardmäßig liefert die Schnittstelle 100 Treffer zurück. Dieser Wert kann über den Parameter limit ausgeweitet  oder eingegrenzt werden. Erfahrungsgemäß ist es bei mehr als 100 Treffern sinnvoll, erst bei Bedarf weitere Treffer über den Parameter offset abzufragen. Nachfolgend ein Beispiel für fünf Treffer der Straßenliste.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/action/datastore/search.json?resource_i...

Rückgabetyp: Dictionary

offset

Über den Parameter offset können die nächsten Treffer abgefragt werden. Standardmäßig werden 100 Treffer zurückgegeben, wenn der Rückgabewert nicht über den Parameter limit manipuliert wurde. Nachfolgend ein Beispiel für alle Treffer der Straßenliste, nach den ersten zehn Einträgen.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/action/datastore/search.json?resource_i...

Rückgabetyp: Dictionary

query

Über den Parameter query kann unmittelbar nach einem Begriff in einer Ressource gesucht werden. Im nachfolgenden Beispiel wird nach „Schleuse“ in der Straßenliste gesucht.

Beispielaufruf: https://geo.muelheim-ruhr.de/api/action/datastore/search.json?resource_i...

Siehe DKAN-API-Dokumentation für mehr Details: Datastore-API.