GET-Anforderung an Geocode

Mithilfe der GET-Anforderung können Sie eine Eingabeadresse und Vergleichs- und/oder Geocoding-Einstellungen an den Geocode-Dienst übermitteln und eine Antwort erhalten, die das Objekt des Kandidaten liefert. Dieses enthält die zugehörigen Koordinaten für den Breitengrad/Längengrad und weitere Vergleichs- und Standortinformationen zu jedem Kandidaten. Die Einstellungsoptionen für eine GET-Anforderung sind eine Teilmenge der Gesamtsumme, die mit der POST-Anforderung verfügbar ist.

Basis-URI

http://<server>:<port>/rest/GlobalGeocode/geocode[.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

[query parameters] werden im folgenden Abschnitt beschrieben. Jedes Schlüssel-Wert-Paar, das in die Anforderung eingegeben wird, wird durch ein kaufmännisches Und-Zeichen getrennt.

Abfrageparameter

In der nachfolgenden Tabelle werden die GET-Abfrageparameter für den Geocode-Dienst definiert. Weitere Informationen zur Antwort finden Sie unter GeocodeServiceResponse-Objekt.

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:
postalCode	Zeichenfolge	Die Postleitzahl 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.
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.
fallbackGeo	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.
fallbackPostal	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.
maxCands	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