POST-Anforderung an Geocode

Mithilfe der POST-Anforderung können Sie eine einzelne Eingabeadresse oder eine Liste von Adressen zur Batch-Verarbeitung senden. Vergleichs- und/oder Geocoding-Einstellungen können optional für den Geocode-Dienst angegeben werden. Zudem erhalten Sie die zugehörigen Koordinaten für den Breitengrad/Längengrad sowie Standortinformationen. Die Einstellungsoptionen für eine POST-Anforderung sind die vollständige Gruppe der verfügbaren Optionen.

Basis-URI

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

Wo:

.[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:
  • addresses: Die Adresse oder die Adressen, für die ein Geocoding ausgeführt werden soll. Erforderlich.
  • type: Der Typ des Geocodes. Optional:
  • preferences: Die Vergleichs- und Geocoding-Optionen. Optional:
  • mustMatchMode: Die Vergleichskriterien zum Ermitteln der übereinstimmenden Kandidaten. Optional.
  • returnFieldsDescriptor: Steuert die Rückgabe zusätzlicher Daten zu einem Kandidaten. Optional:
Diese Objekte und ihre Elemente werden in der folgenden Tabelle definiert.

Adressparameter

>Das Adressenarray von Address-Objekten. Das Array „addresses“ kann eine oder mehrere Eingabeadressen enthalten. Das Adressenelement ist ein erforderliches Element.

Parameter Typ Beschreibung
placeName Zeichenfolge Gebäudename, Ortsname, Point of Interest (POI), Unternehmens- oder Firmenname, der mit der eingegebenen Adresse verknüpft ist. Optional: Beispiel:

Pitney Bowes
4750 Walnut St.
Boulder, CO 80301

mainAddress Zeichenfolge Einzeilige Eingabe: Wenn kein anderes Feld ausgefüllt ist, wird der Eintrag mainAddress als Eingabe in eine einzelne Zeile verarbeitet. Es kann sich dabei um eine Sammlung von Adressfeldelementen handeln. Die Eingabereihenfolge der Adressfelder sollte der standardmäßigen Adressenformatierung Ihres Landes entsprechen. Optional: Beispiel:

4750 Walnut St., Boulder CO, 80301

Straßenanschrift: Wenn die Adressfelder (placeName, lastLine, postalCode usw.) separat eingegeben werden, wird der Inhalt dieses Feldes als der Teil für die Straßenanschrift verwendet und kann den Unternehmensnamen, die Hausnummer, Gebäudenamen und Straßennamen beinhalten. Optional:

Straßenkreuzungseingabe: Um eine Kreuzung einzugeben, geben Sie die beiden Straßennamen ein, und trennen Sie sie anhand eines doppelten kaufmännischen Und-Zeichens (&&).

lastLine Zeichenfolge Die letzte Zeile der Adresse. Optional:
areaName1 Zeichenfolge Gibt das größte geografische Gebiet an, normalerweise ein Bundesland oder Kanton. Optional:
areaName2 Zeichenfolge Gibt das zweitgrößte geografische Gebiet an, normalerweise ein Bezirk oder Landkreis. Optional:
areaName3 Zeichenfolge Gibt einen Stadt- oder Ortsnamen an. Optional:
areaName4 Zeichenfolge Gibt die Unterteilung eines Ortes oder einer Lokalität an. Optional:
postCode1 Zeichenfolge Die Postleitzahl im entsprechenden Format des Landes. Optional:
postCode2 Zeichenfolge Die Postleitzahlerweiterung im entsprechenden Format des Landes. Optional:
country Zeichenfolge ISO 3166-1 Alpha-3-Ländercode. Erforderlich. Informationen zu Ländercodes erhalten Sie unter Länderreferenzliste und ISO 3166-1-Ländercodes.
addressNumber Zeichenfolge Haus- oder Gebäudenummer.
streetName Zeichenfolge Straßenname.
unitType Zeichenfolge Gibt den Typ der Einheit an, z. B. Wohnung, Etage und Gebäude.
unitValue Zeichenfolge Gibt den Wert/die Nummer der Einheit an, z. B. „3B“.

Typparameter

Das type -Objekt vom Typ geocodeType hat die folgenden Parameter. Der Typparameter ist optional.
Parameter Typ Beschreibung
geocodeType Zeichenfolge

Gibt den auszuführenden Geocode-Typ an. Optional:

Address
Geocode zu einer Straßenanschrift. Standardeinstellung.
Geographic
Geocode zum geografischen Mittelpunkt eines Ortes oder Bundeslands/Kantons.
Postal
Geocode zu einer Postleitzahl.

Präferenzparameter

Das preferences-Objekt des Typs Preferences besteht aus den folgenden Elementen. Die folgenden Elemente gelten nur für den Geocode-Dienst. Das preferences-Element ist optional.

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.fallbackToGeographic.

Parameter Typ Beschreibung
returnAllCandidateInfo Boolean Gibt an, ob alle verfügbaren Informationen für jeden Kandidaten zurückgegeben werden sollen.
True
Alle verfügbaren Informationen für jeden Kandidaten zurückgeben.
False
Alle verfügbaren Informationen für jeden Kandidaten nicht zurückgeben. Standardeinstellung.
fallbackToGeographic Boolean Gibt an, ob versucht werden soll, den Mittelpunkt einer geografischen Region zu bestimmen, wenn kein Geocode auf Adressebene bestimmt werden kann. Optional:
True
Geografischen Mittelpunkt zurückgeben, wenn kein Mittelpunkt auf Adressebene bestimmt werden kann. Standardeinstellung.
False
Geografischen Mittelpunkt nicht zurückgeben, wenn kein Mittelpunkt auf Adressebene bestimmt werden kann.
fallbackToPostal Boolean Gibt an, ob versucht werden soll, den Mittelpunkt einer Postleitzahl zu bestimmen, wenn kein Geocode auf Adressebene bestimmt werden kann. Optional:
True
Postleitzahlmittelpunkt zurückgeben, wenn kein Mittelpunkt auf Adressebene bestimmt werden kann. Standardeinstellung.
False
Postleitzahlmittelpunkt nicht zurückgeben, wenn kein Mittelpunkt auf Adressebene bestimmt werden kann.
FALLBACK_TO_WORLD Zeichenfolge Wenn XWG installiert ist: Gibt an, ob der World Geocoder (XWG) zum Ermitteln eines Geocodes verwendet werden soll, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist. Der World Geocoder (XWG) gibt entweder einen postalischen oder einen geografischen Geocode zurück, je nach dem Unterstützungsgrad im XWG-Geocoding-Dataset. Optional:
True
Den World Geocoder (XWG) für den Vergleich verwenden, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist.
False
Den World Geocoder (XWG) nicht für den Vergleich verwenden, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist. Standardeinstellung.
maxReturnedCandidates Ganze Zahl Die maximale Anzahl zurückzugebender Kandidaten. Optional: Muss ein Ganzzahlwert sein. Standard = 1.
streetOffset Double Gibt den Versatzabstand von den Straßensegmenten an, die beim Geocoding auf Straßenebene verwendet werden sollen. 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. Da sich das Gebäude, das durch eine Adresse bezeichnet wird, nicht auf der Straße selbst befindet, sollte der Geocode für eine Adresse kein Punkt auf der Straße sein. Stattdessen soll der Geocode den Standort des Gebäudes darstellen, das sich neben der Straße befindet. 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. Im folgenden Diagramm wird ein Versatzpunkt im Vergleich zum ursprünglichen Punkt dargestellt.

streetOffsetUnits Zeichenfolge Gibt die Maßeinheit für den Straßenversatz an. Zur Auswahl stehen:
  • Feet
  • Meters - Default
cornerOffset Double Gibt die Entfernung für den Versatz der Straßenendpunkte beim Vergleich auf Straßenebene an. Die Entfernung wird in den Einheiten angegeben, die Sie in der Option cornerOffsetUnits angeben. 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 Gibt die Maßeinheit für den Eckversatz an. Zur Auswahl stehen:
  • Feet
  • Meters - Default
matchMode Zeichenfolge Der Abgleichmodus legt fest, wie genau die Übereinstimmung zwischen der Eingabeadresse und den Referenzdaten sein muss. Wählen Sie einen Vergleichsmodus basierend auf der Qualität Ihrer Eingabe sowie der gewünschten Ausgabe aus. Die folgenden Abgleichmodi sind verfügbar:
Exact
Für diesen Modus ist eine sehr genaue Übereinstimmung erforderlich. Dieser stark eingeschränkte Modus generiert die geringste Anzahl an Kandidaten, wodurch die Verarbeitungszeit und die Anzahl der Übereinstimmungen reduziert werden. Wenn Sie diesen Modus verwenden, müssen Sie sicherstellen, dass Ihre Eingabe qualitativ hochwertig sowie frei von Tippfehlern und unvollständigen Angaben ist.
Standard
Für diesen Modus ist eine weitgehende Übereinstimmung erforderlich, und es wird eine kleinere Anzahl von Kandidaten generiert. Standardeinstellung.
Relaxed
In diesem Modus ist eine geringere Übereinstimmung zugelassen, und es wird die größte Anzahl an Kandidaten generiert. Dies führt zu längeren Verarbeitungszeiten und mehr Mehrfachübereinstimmungen. Verwenden Sie diesen Modus, wenn Sie nicht sicher sind, dass Ihre Eingabe qualitativ hochwertig sowie frei von Tippfehlern und unvollständigen Angaben ist.
Custom
Ermöglicht es, die Vergleichskriterien zu definieren, indem die Felder MustMatch eingestellt werden. Sie können die Felder MustMatch allerdings nur mithilfe einer POST-Anforderung einstellen. Bei einer GET-Anforderung werden die MustMatch-Standardwerte verwendet. Weitere Informationen zu den MustMatch-Feldern erhalten Sie unter mustMatchFields.
Interactive (USA only)
Nur bei einzeiligem Adressabgleich verfügbar. In diesem Modus können die spezifischen Herausforderungen des interaktiven Abgleichs besser bewältigt werden. Im interaktiven Modus können flexiblere Übereinstimmungsmuster verwendet werden, was in einigen Fällen zusätzliche Kandidaten im Vergleich zum gelockerten Modus generiert.
CASS (USA only)
Schreibt zusätzliche Regeln vor, um Compliance mit den USPS CASS-Vorschriften zu gewährleisten. Dieser Vergleichsmodus dient dazu, postversandfähige Adressen für USPS-Postrabatte zu generieren. Verwenden Sie diesen Modus, um Ihre Eingabe für den Postversand zu generieren. Der Modus generiert eine große Anzahl von Kandidaten.
clientCoordSysName Zeichenfolge Gibt das Koordinatensystem an, in das Sie die Geometry 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.

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, mustMatchFields 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 dreistelligen ISO-3166-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>USA.maxReturnedCandidates</key>
  <value>3</value>
 </entry>
</customPreferences>
Benutzerdefinierte landesspezifische Eingabeoptionen sind für die folgenden Länder verfügbar:

Für Länder, die sowohl benutzerdefinierte Benutzerwörterbücher als auch standardmäßige Geocoding-Datasets unterstützen, können Sie 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.

Wenn der World Geocoder (XWG) installiert ist, können Sie eine benutzerdefinierte Einstellung namens FALLBACK_TO_WORLD festlegen. Diese Einstellung gibt an, ob der XWG zum Ermitteln eines Geocodes verwendet werden soll, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist. XWG gibt entweder einen postalischen oder einen geografischen Geocode entsprechend dem Unterstützungsgrad im XWG-Geocoding-Dataset zurück. Optional:

True
Den World Geocoder (XWG) für den Vergleich verwenden, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist.
False
Den World Geocoder (XWG) nicht für den Vergleich verwenden, wenn kein Land-Geocoder installiert ist oder ein Land-Geocoder ohne ein Geocoding-Dataset installiert ist. Standardeinstellung.
preferredDictionaryOrder List<String> Gibt die Suchreihenfolge für das Wörterbuch an, wenn mehrere Wörterbücher installiert sind. Die standardmäßige Suchreihenfolge ist die Sortierung, in der die Wörterbücher konfiguriert sind.

mustMatchFields-Parameter

Das mustMatchFields-Objekt vom Typ FieldsMatching ermöglicht das Festlegen der Vergleichskriterien zum Ermitteln von übereinstimmenden Kandidaten. Um diese Optionen zu aktivieren, müssen Sie das Feld matchMode auf Custom setzen.

Um den Standardwert eines mustMatchFields-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: „CAN.matchOnAddressNumber“.

Parameter Typ Beschreibung
matchOnAddressNumber Boolean
True
Es muss eine Übereinstimmung mit der eingegebenen Adressnummer gefunden werden.
False
Eine Übereinstimmung mit der eingegebenen Adressnummer muss nicht gefunden werden. Standardeinstellung.
matchOnPostCode1 Boolean
True
Es muss eine Übereinstimmung mit dem Eingabefeld PostCode1 gefunden werden.
False
Eine Übereinstimmung mit dem Eingabefeld PostCode1 muss nicht gefunden werden. Standardeinstellung.
matchOnAreaName1 Boolean
True
Es muss eine Übereinstimmung mit dem Eingabefeld AreaName1 gefunden werden.
False
Eine Übereinstimmung mit dem Eingabefeld AreaName1 muss nicht gefunden werden. Standardeinstellung.
matchOnAreaName2 Boolean
True
Es muss eine Übereinstimmung mit dem Eingabefeld AreaName2 gefunden werden.
False
Eine Übereinstimmung mit dem Eingabefeld AreaName2 muss nicht gefunden werden. Standardeinstellung.
Anmerkung: Diese Option wird für die USA nicht unterstützt.
matchOnAreaName3 Boolean
True
Es muss eine Übereinstimmung mit dem Eingabefeld AreaName3 gefunden werden.
False
Eine Übereinstimmung mit dem Eingabefeld AreaName3 muss nicht gefunden werden. Standardeinstellung.
matchOnAreaName4 Boolean
True
Es muss eine Übereinstimmung mit dem Eingabefeld AreaName4 gefunden werden.
False
Eine Übereinstimmung mit dem Eingabefeld AreaName4 muss nicht gefunden werden. Standardeinstellung.
matchOnAllStreetFields Boolean
True
Eine Übereinstimmung mit den Eingabefeldern für den Straßennamen, den Straßentyp und die Richtung muss gefunden werden.
False
Eine Übereinstimmung mit den Eingabefeldern für den Straßennamen, den Straßentyp und die Richtung muss nicht gefunden werden. Standardeinstellung.
mustMatchInput Boolean
True
Die anderen Felder, bei denen eine Übereinstimmung erforderlich ist, werden ignoriert und alle möglichen angegebenen Eingabefelder (Postleitzahl, Gebietsnamen usw.) müssen mit dem Kandidaten übereinstimmen, damit dieser zurückgegeben wird.
False
Die anderen Felder, bei denen eine Übereinstimmung erforderlich ist, werden berücksichtigt. Es ist keine Übereinstimmung zu einem bestimmten angegebenen Eingabefeld erforderlich, damit der Kandidat zurückgegeben wird. Standardeinstellung.

returnFieldsDescriptor

Das returnFieldsDescriptor-Objekt des Typs returnFieldsDescriptor steuert die Rückgabe zusätzlicher Daten eines Kandidaten. Standardmäßig werden die erweiterten Kandidateninformationen nicht zurückgegeben. In Fällen, in denen jedoch mehrere verfügbar sind, können sie folgendermaßen gesteuert werden:

Um den Standardwert eines returnFieldsDescriptor-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: „AUS.returnAllCustomFields“.

Parameter Typ Beschreibung
returnAllCustomFields Boolean
True
Alle benutzerdefinierten Felder für den Kandidaten zurückgeben.
False
Nur die Standardgruppe der Felder für den Kandidaten zurückgeben. Standardeinstellung.
returnedCustomFieldKeys List<String> Gibt eine Liste von Schlüsseln an, welche die benutzerdefinierten Felder darstellen, die in der Ausgabe customFields des Kandidaten zurückgegeben werden sollen. Beispiel: „CTYST_KEY“ oder „DATATYPE“. Standard: leer.
Anmerkung: Um mehrere Schlüssel-Wert-Paare für ein Land anzugeben, trennen Sie die Namen der zurückzugebenden benutzerdefinierten Felder mit Leerzeichen. Beispiel: "USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY". Kandidaten, bei denen diese Informationen verfügbar sind, enthalten die drei benutzerdefinierten Felder mit diesen Schlüsseln in der Ausgabe customFields des Kandidaten.
Anmerkung: Benutzerdefinierte Felder unterscheiden sich von Land zu Land. Die für Ihr Land geltenden Informationen finden Sie im Abschnitt Landesspezifische Informationen im Anhang, in dem weitere Details aufgeführt werden.
returnMatchDescriptor Boolean
True
Das Deskriptorobjekt der Übereinstimmung zurückgeben. Dieses gibt die Teile des Kandidaten an, die mit der eingegebenen Adresse übereinstimmten.
False
Das Deskriptorobjekt der Übereinstimmung nicht zurückgeben. Standardeinstellung.
returnStreetAddressFields Boolean
True
Alle einzelnen Straßenfelder, aus denen das Feld formattedStreetAddress zusammengesetzt ist, folgendermaßen einzeln zurückgeben:
  • MAIN_ADDRESS: Der Basisteil eines Straßennamens. Beispiel: „River“ in „13 River Ave“
  • THOROUGHFARE_TYPE: Der Landstraßentyp, der vor oder nach dem Straßennamen angegeben wird, z. B. Ave, Via, Str., Rd usw.
  • ADDRESS_ID: Die eindeutige Kennung für die Adresse in den Quelldaten.
  • PRE_ADDRESS: Der Wert kann Artikel usw. enthalten, die vor dem Hauptstraßennamen angegeben werden. Beispiel: „de la“ in „Calle de la mesa“
  • POST_ADDRESS: Der Wert kann Wörter usw. enthalten, die nach dem Hauptstraßennamen angegeben werden. Beispiel: „de la tiedra“ in „Calle Ramon Perez de la tiedra“
  • PRE_DIRECTIONAL: Der Wert enthält eine Richtungsangabe, die vor dem Hauptstraßennamen angegeben wird. Beispiel: „South“ in „123 South Main St“
  • POST_DIRECTIONAL: Der Wert enthält eine Richtungsangabe, die nach dem Hauptstraßennamen angegeben wird. Beispiel: „SW“ in „123 River St SW“
False
Einzelne Straßenfelder nicht einzeln zurückgeben. Diese Werte im Feld formattedStreetAddress zurückgeben. Standardeinstellung.
returnUnitInformation Boolean
True
Soweit verfügbar, Informationen zum Einheitstyp und Einheitswert einzeln in den Feldern unitType und unitValue sowie im Feld formattedStreetAddress zurückgeben.
False
Soweit verfügbar, Informationen zum Einheitstyp und Einheitswert ausschließlich im Feld formattedStreetAddress zurückgeben. Standardeinstellung.