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 Einstellungen für eine GET-Anforderung sind eine Teilmenge der Gesamtsumme, die mit der POST-Anforderung verfügbar ist. Jedes Schlüssel/Wert-Paar ist durch ein Und-Zeichen (&) getrennt.

Basis-URI

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

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

POST: mainAddressLine

GET: 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

Mehrzeilige Eingabe: Wenn die Adressfelder (placeName, lastLine, postalCode usw.) separat eingegeben werden, wird der Inhalt dieses Feldes als der Teil der 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 (&&).

country Zeichenfolge ISO 3166-1 Alpha-3-Ländercode. Erforderlich. Informationen zu Ländercodes erhalten Sie unter Ländercodes gemäß ISO 3166-1.
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:

POST: postCode1

GET: postalCode

Zeichenfolge Die Postleitzahl im entsprechenden Format des Landes. Optional:

POST: postCode2

Zeichenfolge Die Postleitzahl im entsprechenden Format des Landes. Optional:
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

POST: addressLastLine

GET: lastLine

Zeichenfolge Die letzte Zeile der Adresse. Optional:
matchMode Zeichenfolge Der Vergleichsmodus 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 Vergleichsmodi 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.
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.
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 finden Sie unter mustMatchFields.
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.
maxRanges Ganze Zahl Bei einem Bereich handelt es sich um eine Reihe von Adressen an einem Straßensegment entlang. Beispiel: 5400–5499 Main St. Repräsentiert einen Adressbereich im 5400-er Block der Main St. Ein Bereich kann nur ungerade oder nur gerade Adressen innerhalb eines Segments darstellen, aber auch beide Typen. Ein Bereich kann auch ein einzelnes Gebäude mit mehreren Einheiten darstellen, z. B. ein Wohnhaus.

Diese Option gibt die maximale Anzahl an Bereichen an, die für jeden Kandidaten zurückgegeben werden sollen. Da der Geocoder einen Kandidaten pro Segment zurückgibt und ein Segment mehrere Bereiche enthalten kann, können Sie mithilfe dieser Option die anderen Bereiche im Segment eines Kandidaten anzeigen.

Muss ein Ganzzahlwert sein. Standardeinstellung = 0.

maxRangeUnits Ganze Zahl Diese Option gibt die maximale Anzahl an Einheiten (z. B. Apartments oder Etagen) an, die für jeden Bereich zurückgegeben werden sollen.

Wenn Sie beispielsweise Geocoding für ein Bürogebäude in der 65. Main St. mit vier Suiten durchführen, würden maximal vier Einheiten für den Gebäudebereich zurückgegeben werden: 65 Etage 1, 65 Etage 2, 65 Etage 3 und 65 Etage 4. Wenn Sie die Maximalzahl der Einheiten als 2 angeben, würden nur zwei statt alle vier Einheiten zurückgegeben werden.

Muss ein Ganzzahlwert sein. Standardeinstellung = 0.

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