Alle hier präsentierten Daten können als OpenData-Datensätze abgegriffen werden. Als Formate stehen JSON, GeoJSON und KML zur Verfügung. Die Daten stehen unter der Lizenz.
Parameter
Um die Daten abzurufen, können sowohl GET als auch POST Requests gesendet werden, wobei POST durch Encodierungs-Probleme oft die bessere Wahl ist. Folgende Parameter sind dabei verpflichtend:
- type: Muss immer „service“ lauten. Datentyp: String(32).
- key: Muss immer „AwTgnZoCbZ7PR9xBDb3b“ lauten. Datentyp: String(32).
- f: Die ID, ab der die Daten ausgegeben werden. Um zum Beispiel eine Blätter-Funktion zu implementieren, muss auf Seite 1 f=0, auf Seite 2 f=10, auf Seite 3 f=20 etc abgefragt werden. Datentyp: Integer.
Folgende optionale Parameter sind ebenfalls möglich:
- c: Die Anzahl der Ergebnisse. Möchte man alle Datensätzte auf einmal, so kann man dort eine hohe Zahl eingeben (z.B. 1024). Datentyp: Integer.
- fe: Möchte man eine geografische Suche haben, so beschreibt dieser Parameter eine Liste an Feldern, welche geografisch durchsucht werden sollen. Aktuell ist nur das Feld „location“ mit Geodaten belegt, der Wert wäre also [„location“]. Datentyp: Array of String(32).
- q: Der Text, nach dem gesucht werden soll. Datentyp: String(256).
- fq: Suche nach Terms. Es werden mehrere Term-Basen unterstützt, aktuell wird nur „service-category-all.term“ verwendet. Die Kategorie hat Kinder und Kindeskinder, es werden automatisch immer auch Einträge ausgegeben, die in Kinder-Kategorien enthalten sind. Datentyp: Object mit Array of String pro Term-Basis. Beispiel: {„service-category-all.term“: [„Begleitung – Besuchsdienste“]}.
JSON-Endpunkt
https://v2.api.wp-fastsearch.de/search?type=service&key=AwTgnZoCbZ7PR9xBDb3b&f=0
Der JSON-Endpunkt gibt alle relevanten Daten als Liste von JSON-Objekten aus. Zudem bekommt man über total die Gesamtzahl der Ergebnisse.
GeoJSON-Endpunkt
https://v2.api.wp-fastsearch.de/search/geo?type=service&key=AwTgnZoCbZ7PR9xBDb3b&f=0&c=1024&fe=["location"]
Um die Einrichtungen in Kartenanwendungen zu integrieren, lohnt sich eine Abfrage als GeoJSON, da dies von fast allen Karten unterstützt wird (v.a. von den OpenStreetMap-basierten Karten). Ausgegeben wird ein GeoJSON mit Punkten sowie allen Attributen der Einrichtungen in den GeoJSON properties.
KML-Endpunkt
https://v2.api.wp-fastsearch.de/search/kml?type=service&key=AwTgnZoCbZ7PR9xBDb3b&f=0&c=1024&fe=["location"]
Google Maps unterstützt zwar in neueren Versionen auch GeoJSON, in der Google-Welt ist KML aber erheblich verbreiteter. Daher bieten wir auch einen KML Endpunkt an.