Location Service

/autocomplete
/search
/status

`/autocomplete`

Parameter	Wert
`zip`	eine PLZ (z. B. 68789)

Ablauf

Die Suche wird nur auf der lokalen Datenbank mit den eigenen Ortsteil-Daten (die in regelmäßigen Abständen von der NMID bezogen werden) ausgeführt.

Ergebnis

Im Erfolgsfall liefert der Aufruf die gefundenen Ortsteile in einem data-Element.

Ortsteile enthalten eine normalized-Eigenschaft (Format: "PLZ, Ortsteil, Ort"), die man für ein Autocomplete-Dropdown verwenden kann.

Beispiel

`/search`

Freie Abfrage

Parameter	Wert
`s`	eine Adresse (z. B. "68789, Opelstr.")

Ablauf

Die Suche besteht immer aus zwei Teilabfragen (an die Nominatim-Instanz und an die eigene Datenbank).

Zuerst wird der s-Parameter an die Nominatim-Instanz gesendet.
Erhält man ein OSM-Ergebnis, das mindestens aus den Adressbestandteilen Straße und PLZ besteht, so wird mit diesen beiden Parametern eine zweite Abfrage an die lokale Datenbank gesendet, um damit eine passende Straße mit dazugehörigem Ortsteil zu finden.
Wenn dadurch keine Straße gefunden wird und das OSM-Ergebnis eine PLZ beinhaltet, so wird mit diesem Parameter eine weitere Abfrage an die lokale Datenbank gesendet, um damit einen passenden Ortsteil zu finden.
Wenn die Nominatim-Instanz kein Ergebnis liefert, so wird versucht, eine PLZ aus dem s-Parameter zu extrahieren, um damit in der lokalen Datenbank einen passenden Ortsteil zu finden.

Ergebnis

Im Erfolgsfall liefert der Aufruf ein data-Element mit den Unterlementen Straße (street), Ortsteile (district) und OSM-Ergebnis (osm).

Beispiel

Strukturierte Abfrage

Parameter	Wert
`street`	eine Straße (z. B. "Opelstr.")
`zip`	eine PLZ (z. B. "68789")
`city`	einen Ort (z. B. "St. Leon-Rot")

Ablauf

Die Suche besteht immer aus zwei Teilabfragen (an die Nominatim-Instanz und an die eigene Datenbank).

Mit den Parametern werden Anfragen an die Nominatim-Instanz und die lokale Datenbank gesendet.
Wenn durch die Anfrage an die lokale Datenbank keine Straße gefunden wird und das OSM-Ergebnis mindestens die Adressbestandteilen Straße und PLZ beinhaltet, so wird mit diesen Parametern eine weitere Abfrage an die lokale Datenbank gesendet, um damit eine passende Straße zu finden.
Wenn diese Abfrage auch kein Ergebnis liefert und der zip-Parameter vorhanden ist, so wird mit diesem Parameter eine weitere Abfrage an die lokale Datenbank gesendet, um damit einen passenden Ortsteil zu finden.

Ergebnis

Im Erfolgsfall liefert der Aufruf ein data-Element mit den Unterlementen Straße (street), Ortsteile (district) und OSM-Ergebnis (osm).

Beispiel

`/status`

Ergebnis

Der Status-Endpunkt macht drei Tests (Erreichbarkeit der Datenbank und der beiden Endpunkten /autocomplete und /search. Wenn alle drei Tests erfolgreich sind, erhält man den Status-Code 200, sonst 503.

Beispiel