Nutzung der DKAN-API

Beispiele für die Nutzung der DKAN-API

Die Landeshauptstadt Düsseldorf veröffentlicht auf dem Open Data Portal regelmäßig Daten aus der Verwaltung - maschinenlesbar und unter freien Lizenzen - in verschiedensten Formaten, beispielsweise .csv und .(geo)json. Die Daten können bei Bedarf über den Button „Daten ansehen“ angezeigt werden und werden dann in einer Vorschau als Tabelle, Grafik oder als Karte visualisiert. Alternativ können die Daten über den Button „Download“ direkt heruntergeladen werden.

Es ist auch möglich, ausgewählte Datensätze direkt über die URL anzusteuern. Dies funktioniert über eine API (Programmierschnittstelle), die Lesezugriff auf die Inhalte des Portals ermöglicht. Um die Nutzung der API zu demonstrieren, folgen einige Beispiele anhand der hier verfügbaren Daten. Die vollständige Dokumentation der DKAN-API ist unter http://docs.getdkan.com/en/latest/apis/index.html zu finden.

Dataset API

Diese API bezieht sich auf das Portal und dessen Inhalte im Allgemeinen. So ist es möglich, den Zustand des Portals auszulesen bis hin zu einer Ausgabe aller vorhandenen Datensätze. Zu erreichen sind die einzelnen Funktionen unter http://opendata.duesseldorf.de/api/3/action/{Name der Funktion} wobei {Name der Funktion} mit einer der unten gelisteten Funktionen zu ersetzen ist.

Nachfolgend einige Funktionen mit den dazugehörigen Links zum Düsseldorfer Portal. Die Ausgabe erfolgt immer im json-Format.

Funktion site_read

• Diese Funktion gibt als Rückmeldung, ob das Portal überhaupt erreichbar ist.
• Beispielaufruf: https://opendata.duesseldorf.de/api/3/action/site_read

Funktion package_list

• Beschreibung: Liefert eine Liste mit allen Datensatz Containern (Dataset)
• Beispielaufruf: https://opendata.duesseldorf.de/api/3/action/package_list

Funktion current_package_list_with_ressources

• Beschreibung: Liefert eine Liste mit allen Datensätzen und den darin beinhaltenden Ressourcen
• Beispielaufruf: https://opendata.duesseldorf.de/api/3/action/current_package_list_with_resources 

Funktion resource_show

• Beschreibung: Zeigt die Metadaten einer Ressource an
• Parameter: id
• Beispielaufruf: https://opendata.duesseldorf.de/api/3/action/resource_show?id=2a3c4e41-a810-42ea-8e31-c2ec455d50b8

Funktion group_list

• Beschreibung: Liefert die Namen der angelegten Gruppen (Datenbereitsteller)
• Beispielaufruf: https://opendata.duesseldorf.de/api/3/action/group_list 

 

Datastore API

Diese API bezieht sich auf Datensätze, die von uns in den internen Datastore geladen wurden. Der Datastore bietet die Möglichkeit, Dateien (zurzeit nur csv) in einem json-Format aufrufbar zu machen. Dies ermöglicht das direkte Arbeiten mit den einzelnen Ressourcen, ohne diese herunterladen zu müssen. Die einzelnen Dateien können nach folgendem Schema aufgerufen werden:

https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id={ID der Ressource}.

 Zurzeit werden Ressourcen, bei denen ein Datastore Zugriff möglich ist, über den Button "Data API" innerhalb der Ressourcenansicht angezeigt. Hier wird auch ein Beispiel-Link mit der jeweiligen Ressourcen ID dargestellt.

Folgende Beispiele beziehen sich auf die Ressource „Tageseinrichtungen für Kinder in Düsseldorf“:

Parameter: limit

• Beschreibung: Beschränkt die Ausgabe auf die angegebene Anzahl der Treffer. Standardmäßig werden 100 Treffer zurückgegeben, dieser Wert kann über den Parameter "limit" erweitert oder eingegrenzt werden. Es wird gerade bei größeren Dateien empfohlen, eine Ausgabe von 100 Treffern nicht zu überschreiten, sondern bei Bedarf an weiteren Treffern den Parameter "offset" zu benutzen.
• Beispielaufruf: https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id=03667f77-61a1-4bb1-b761-61b89f9a4dfc&limit=5

Parameter: offset

• Beschreibung: Legt den Versatz an Treffern fest => die nächsten {n} Treffer werden ausgegeben.
• Beispielaufruf: https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id=03667f77-61a1-4bb1-b761-61b89f9a4dfc&offset=5

Parameter: filters

• Beschreibung: Konditionen, die man auf Felder anwenden kann, um die Trefferliste geeignet einzuschränken.
• Beispielaufruf: https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id=03667f77-61a1-4bb1-b761-61b89f9a4dfc&filters[stadtteil]=62

Parameter: query

• Beschreibung: Sucht nach dem gelisteten Feld in der Ressource.
• Beispielaufruf: https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id=03667f77-61a1-4bb1-b761-61b89f9a4dfc&query=Jugendamt%20D%C3%BCsseldorf

 

Hinweis: alle Parameter sind untereinander kombinierbar, z.B. Ausgabe der ersten 10 Kitas, wobei nur der Stadtteil „62“ berücksichtigt werden soll: https://opendata.duesseldorf.de/api/action/datastore/search.json?resource_id=03667f77-61a1-4bb1-b761-61b89f9a4dfc&filters[stadtteil]=62&limit=10

Die vollständige Dokumentation über die DKAN-API ist unter http://docs.getdkan.com/en/latest/apis/index.html zu finden.