Einstellungen

Vom Geocode-Dienst unterstützte Einstellungen umfassen eine Vielzahl von Einstellungen für den Vergleichsmodus, das Geocoding für einen Straßen- oder Verwaltungsbereich, den Rückgriff zu einem weniger spezifischen Speicherort, wenn keine genaue Übereinstimmung gefunden werden kann, und vieles mehr. In der folgenden Tabelle werden die für alle Länder verfügbaren Einstellungen beschrieben und Hinweise gegeben, wenn eine Einstellung für ein Land nicht gilt. Benutzerdefinierte Einstellungen für alle Länder werden in Benutzerdefinierte Einstellungen erläutert.

Anmerkung: Einige Parameter sind mit POST und GET gekennzeichnet. Diejenigen mit beiden geben einen Unterschied im Parameternamen an. Die Parameter ohne POST und GET werden für beide Anforderungstypen mit dem gleichen Parameternamen verwendet. Andere Parameter sind mit entweder POST oder GET gekennzeichnet.
Parameter Typ Beschreibung

POST: type

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

POST: 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.

POST: fallbackToGeographic

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

POST: fallbackToPostal

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

POST: maxReturnedCandidates

GET: maxCands

Ganze Zahl Die maximale Anzahl zurückzugebender Kandidaten. Optional: Muss ein Ganzzahlwert sein. Standard = 1.
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).
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.
maxRanges Ganze Zahl Bei einem Bereich handelt es sich um eine Reihe von Adressen an einem Straßensegment entlang. Beispiel: 5400–5499 Main St. ist ein Adressbereich, der Adressen im 5400er Block der Main Street darstellt. 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.

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.

POST: 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.

POST: 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.

POST: matchOnPostCode2

Boolean
true
Es muss eine Übereinstimmung mit dem Eingabefeld PostCode2 gefunden werden.
false
Es muss keine Übereinstimmung mit dem Eingabefeld PostCode2 gefunden werden. Standardeinstellung.

POST: 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.

POST: 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.

POST: 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.

POST: 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.

POST: 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.

POST: 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.

POST: 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. Um mehrere Schlüssel-Wert-Paare für ein Land anzugeben, trennen Sie die Namen der zurückzugebenden benutzerdefinierten Felder mit Leerzeichen. Benutzerdefinierte Felder unterscheiden sich von Land zu Land. Beispiel: „CTYST_KEY“ oder „DATATYPE“. Standard: leer.

POST: 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.

POST: returnStreetAddressFields

Boolean
true
Alle einzelnen Straßenfelder, aus denen das Feld formattedStreetAddress zusammengesetzt ist, folgendermaßen einzeln zurückgeben:
  • MAIN_ADDRESS
  • THOROUGHFARE_TYPE
  • ADDRESS_ID
  • PRE_ADDRESS
  • POST_ADDRESS
  • PRE_DIRECTIONAL
  • POST_DIRECTIONAL
false
Einzelne Straßenfelder nicht einzeln zurückgeben. Diese Werte im Feld formattedStreetAddress zurückgeben. Standardeinstellung.

POST: 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.