SimpleSearch API
Jede SimpleSearch-Applikation verfügt über eine einfache REST-API. Damit können Sie den Datenbestand aus einer SimpleSearch-Webanwendung im strukturierten, maschinenlesbaren Format abfragen. Diese REST-APIs werden u.a. auch bei SimpleSearch OpenData veröffentlicht.
Möglichkeiten
Jede SimpleSearch-Anwendung kann folgende technische Formate exportieren:
- XML (siehe SimpleSearch XML)
- JSON (siehe SimpleSearch JSON)
- CSV
- RSS
- JSON-RSS
- HTML
- KML
- GEO-JSON
Folgende Anfragen können Sie stellen:
- Gesamter Datenbestand
- Datenbestand, der auf eine spezielle Suche zutrifft
Vorgehen
- Rufen Sie die Anwendung, für die Sie sich interessieren, in Ihrem Browser auf
- Stellen Sie eine Frage über das Suchformular
- Fügen Sie einen URL-Parameter je nach gewünschtem Datenformat hinzu
Folgende Veränderung muss an der URL nach der Suche vorgenommen werden:
- Aus http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/?q=Test wird http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/index.php/index.FORMAT?q=Test
Für FORMAT setzen Sie dann entsprechend 'json', 'xml', 'rss', 'csv', 'jrss' bzw. 'kml' ein.
Alternativ können Sie sich auch den Quelltext der Seite aufrufen, und den RSS-Eintrag suchen. In diesem Eintrag können Sie dann ".rss" durch ".csv" etc. ersetzen.
Anfragen
Die möglichen Suchparameter leiten Sie bitte aus dem Suchformular ab.
Einen Überblick über erlaubte Parameter ergibt sich auch aus der automatischen Api-Dokumentation mittels .../index.php/api.html.
Einschränkung
Bitte beachten Sie, dass die REST-APIs an der SimpleSearch keine Hochleistungs-APIs sind. Wir bitten also um Caching.