Für die maschinelle Abfrage des Metadatenkatalogs von open.rlp steht eine Schnittstelle zur Verfügung (Endpunkt: https://open.rlp.de/api). Sie ermöglicht den Zugriff auf alle Kernfunktionalitäten von open.rlp über einen API-Client. Dabei handelt es sich um die Standard CKAN API. Für einen tieferen Einstieg in die Thematik bietet sich daher die offizielle Dokumentation in englischer Sprache an. Für Interessierte wird hier die Funktionsweise der API übersichtlich dargestellt.

Die Antwort der Schnittstelle erfolgt grundsätzlich in Form eines JSON-Dictionary mit drei Werten und ihren jeweiligen Schlüsseln:

1. „success“: mit den booleschen Werten true oder false. Die Schnittstelle zielt immer darauf ab, den Status 200 OK als Antwort zu liefern, weshalb es unabdingbar ist, den Wert des Schlüssels „success“ zu überprüfen. Wird als Wert false angezeigt, wird das Problem im Schlüssel „error:“ näher spezifiziert. 

2. „result“: enthält den Rückgabewert der aufgerufenen Funktion, wobei Wert und Typ von der aufgerufenen Funktion abhängig sind. Beim Auftreten eines Fehlers wird alternativ der Schlüssel „error:“ übergeben, der Details zum aufgetretenen Fehler enthält.

3. „help:“ enthält als Wert den Hilfetext zu der aufgerufenen Funktion aus dem Quellcode.

Für den Abruf von Daten dient die Funktion package_search, die nach Paketen sucht, die den angegebenen Suchkriterien entsprechen. Dabei akzeptiert die Aktion Solr-Suchparameter und liefert ein Dictionary mit drei Schlüsseln zurück: ein Dictionary an Ergebnissen, die Anzahl der Suchergebnisse sowie Facetteninformationen.

Die Abfrage kann beispielsweise direkt über den Browser oder cURL getätigt werden. Über den Paramter q wird die Anfrage an Solr Übergeben:

https://open.rlp.de/api/action/package_search?q=denkmalpflege

Der Parameter fq ermöglicht es, die Ergebnisse weiter einzuschränken, indem weitere Suchkriterien angegeben werden.

https://open.rlp.de/api/action/package_search?q=denkmalpflege&fq=tags:bausanierung

Darüber hinaus verfügt die Funktion über weitere Parameter, z.B. zur Filterung und Sortierung der Ergebnisse. Eine vollständige Auflistung entnehmen Sie bitte der offiziellen Dokumentation.

Über die API können so große Datenbestände automatisiert durchsucht, abgegriffen und weiterverarbeitet werden. Durch die offenen Lizenzen der Daten können technikaffine Personen den Datenbestand von open.rlp für eigene Anwendungen nachnutzen und daraus einen Mehrwert generieren!

Grundsätzlich sind die Liefersysteme über einen Harvester angebunden, der in einem Pull-Verfahren die Daten in regelmäßigen Abständen abruft. Daneben ist in Ausnahmefällen eine Belieferung von open.rlp über die API möglich. Wir freuen uns über Ihr Interesse, wenn Sie Daten als Liefersystem bereitstellen wollen. Treten Sie dafür gerne mit uns in Kontakt, damit wir einen geeigneten Modus für die Bereitstellung ihrer Daten besprechen und Ihnen weitere Informationen zur Verfügung stellen können!