POST-Anforderung an Reverse Geocode

Mithilfe der POST-Anforderung können Sie eine einzelne Eingabekoordinate oder eine Liste von Koordinaten zur Batch-Verarbeitung senden. Optional können Sie einen Ländercode, ein referenziertes Koordinatensystem und Vergleichseinstellungen angeben. Die zurückgegebene Antwort enthält eine Liste von Kandidaten mit zugehörigen Adressdaten und Übereinstimmungsinformationen. Die Einstellungsoptionen für eine POST-Anforderung sind die vollständige Gruppe der verfügbaren Optionen.

Basis-URI

http://<server>:<port>/rest/GlobalGeocode/reverseGeocode[.content type]

Dabei gilt:

.[content type] gibt an, dass der angegebene Inhaltstyp standardmäßig verwendet wird. Optional:
json
JSON ist der standardmäßige Inhaltstyp, es sei denn, er wird durch eine HTTP-Inhaltsaushandlung ersetzt
xml
XML ist der standardmäßige Inhaltstyp, es sei denn, er wird durch eine HTTP-Inhaltsaushandlung ersetzt

Anforderungsparameter

Die POST-Anforderung umfasst die folgenden Eingabeparameter:
  • points: Die Eingabekoordinaten oder mehrere Eingabekoordinaten für das Reverse Geocoding. Erforderlich.
  • preferences: Die Vergleichsoptionen. Optional:
Diese Objekte und ihre Elemente werden in der folgenden Tabelle definiert.
Name Typ Beschreibung
points: Ein Arrayobjekt, das ein Geometrieobjekt und eine Ländercodezeichenfolge enthält:
country Zeichenfolge Zeigt das Land als dreistelligen ISO-Ländercode an, das für das Ergebnis des Reverse Geocoding zu durchsuchen ist. Optional: Informationen zu Ländercodes erhalten Sie unter Ländercodes gemäß ISO 3166-1.
Geometry-Objekt, das aus den folgenden Elementen besteht:
coordinates Double Gibt die Eingabekoordinaten im Format „x, y“ an, wobei „x“ den Längengrad und „y“ den Breitengrad repräsentiert. Beispiel: [ -105.25175, 40.024494 ]
type Zeichenfolge Gibt den Typ der geografischen Entität an, die die Eingabekoordinaten repräsentieren.
point
Die Eingabekoordinaten repräsentieren eine Punktposition.
crs Zeichenfolge Gibt das referenzierte Koordinatensystem an, das für die Eingabekoordinaten verwendet wird. Das Format muss dem EPSG-Code (European Petroleum Survey Group) oder dem SRID-Code entsprechen. Standardeinstellung = EPSG:4326. Geben Sie das referenzierte Koordinatensystem im Format „codespace:code“ an.
preferences-Objekt, das aus den folgenden Elementen besteht.
Anmerkung: Nur die folgenden Elemente im preferences-Objekt sind für den Reverse Geocode-Dienst verwendbar.
Anmerkung: Um den Standardwert eines preferences-Elements für ein bestimmtes Land außer Kraft zu setzen, geben Sie das Schlüssel-Wert-Paar im Objekt customPreferences an, wobei vor der Schlüsselkonstanten der dreistellige ISO-3166-Ländercode mit einem Punkt steht. Beispiel: DEU.streetOffset.
distance Double Legt den Radius fest, in dem der Reverse Geocode-Dienst nach einer Übereinstimmung zu den Eingabekoordinaten sucht. Die Maßeinheit wird über distanceUnits angegeben. Standard = 150 Meter. Maximaler Wert = 5280 Fuß (1 Meile) oder 1609 Meter.
distanceUnits Zeichenfolge Gibt die Maßeinheit für die Suchentfernung an. Zur Auswahl stehen:
  • Feet
  • Meters - Default
clientLocale Zeichenfolge Dieses Feld wird für ein Land verwendet, in dem mehrere Sprachen verwendet werden, um die bevorzugte Reihenfolge der Sprachkandidaten festzulegen. Das Gebietsschema muss im Format „cc_CC“ angegeben werden, wobei „cc“ für die Sprache steht und „CC“ der ISO 3166-1 Alpha-2-Code ist, wie in en-US, fr_CA oder fr_FR.

Für Ägypten wird beispielsweise sowohl Englisch als auch Arabisch unterstützt. Im Feld „clientLocale“ könnte entweder Englisch (en-EN) oder Arabisch (ar-EG) als erste Sprache festgelegt werden.

Anmerkung: Eine Auflistung der ISO Alpha-2-Ländercodes finden Sie unter Ländercodes gemäß ISO 3166-1.

POST: clientCoordSysName

Zeichenfolge Gibt das Koordinatensystem an, in das Sie die Geometrie umwandeln möchten. Das Format muss dem EPSG-Code (European Petroleum Survey Group) oder dem SRID-Code entsprechen. Standardeinstellung = EPSG:4326.

Geben Sie das referenzierte Koordinatensystem im Format codespace:code an.

streetOffset Double Der Versatzabstand von den Straßensegmenten. Die Entfernung wird in den Einheiten angegeben, die Sie in der Option streetOffsetUnits angeben. Standardwert = 7 m.

Der Versatzabstand dient beim Geocoding auf Straßenebene zur Vermeidung der Positionierung des Geocodes in der Mitte der Straße. Er gleicht den Umstand aus, dass beim Geocoding auf Straßenebene ein Punkt für den Breitengrad und den Längengrad in der Mitte der Straße, an der sich die Adresse befindet, zurückgegeben wird.

Ein Versatz von 50 Fuß bedeutet beispielsweise, dass der Geocode einen Punkt darstellt, der 50 Fuß von der Mitte der Straße entfernt ist. Die Entfernung wird senkrecht zum Teil des Straßensegments der Adresse berechnet. Mithilfe des Versatzes wird auch verhindert, dass einander gegenüberliegende Adressen denselben Punkt erhalten.
streetOffsetUnits Zeichenfolge Maßeinheit für den Straßenversatz. Einer der folgenden Werte: Fuß, Meter (Standard).
cornerOffset Double Die Entfernung für den Versatz der Straßenendpunkte beim Vergleich auf Straßenebene. Die Entfernung wird in den Einheiten angegeben, die Sie für die Einstellung cornerOffsetUnits angegeben haben. Mithilfe dieses Wertes wird verhindert, dass Adressen an Straßenecken denselben Geocode wie die Kreuzung erhalten. Definiert die Versatzposition des geocodierten Punktes in Bezug auf die Ecke. Standardwert = 7 m.

Im folgenden Diagramm werden die Endpunkte einer Straße mit Versatzendpunkten verglichen.

cornerOffsetUnits Zeichenfolge Maßeinheit für den Straßenversatz. Einer der folgenden Werte: Fuß, Meter (Standard).
customPreferences Map<String key, String value> Gibt die landesspezifischen Eingabeeinstellungen an. Mithilfe dieses Objekts können Sie Folgendes angeben:
  • Eine landesspezifische Außerkraftsetzung von einem oder mehreren Elementen in den Objekten preferences oder returnFieldsDescriptor.
  • Eine benutzerdefinierte landesspezifische Eingabeoption.
Um den Standardwert für ein bestimmtes Land außer Kraft zu setzen, stellen Sie der Schlüsselkonstanten den ISO-3-Ländercode sowie einen Punkt voran und geben Sie anschließend den Wert an. In einer XML-Anforderung würde eine Eingabe für eine landesspezifische Außerkraftsetzung beispielsweise folgendermaßen aussehen:
<customPreferences>
   <entry>
      <key>CAN.distance</key>
      <value>300</value>
   </entry>
</customPreferences>
Benutzerdefinierte landesspezifische Eingabeoptionen sind für die folgenden Länder verfügbar:Außerdem können Sie für Länder, die sowohl benutzerdefinierte Benutzerwörterbücher als auch standardmäßige Geocoding-Datasets unterstützen, eine benutzerdefinierte Einstellung mit dem Schlüssel KEY_CUSTOM_DICTIONARY_USAGE festlegen, der die Such- und Vergleichseinstellungen definiert, wenn in der Geocoding-Engine sowohl benutzerdefinierte Benutzerwörterbücher als auch standardmäßige Geocoding-Datasets verfügbar sind. Diese Option ist nur beim Forward Geocoding verfügbar. Weitere Informationen finden Sie unter Festlegen von Such- und Vergleichseinstellungen bei Verwendung von Standard- und Benutzerwörterbüchern. Informationen dazu, ob Ihr Land benutzerdefinierte Benutzerwörterbücher unterstützt, erhalten Sie im Abschnitt „Unterstützte Geocoding-Datasets“ im Kapitel des jeweiligen Landes.