GeocodeServiceResponse-Objekt

Eine Anforderung an den Geocode-Dienst gibt ein GeocodeServiceResponse-Objekt mit dem folgenden Inhalt zurück:
  • totalPossibleCandidates: Die Gesamtzahl der möglichen Kandidaten.
  • totalMatches: Die Gesamtzahl der Übereinstimmungen.
  • Candidates: Führt einen oder mehrere Kandidaten auf, die mit Ihrer Eingabeadresse/Ihren Eingabeadressen übereinstimmten. Vergleichs- und Standortinformationen werden für jeden übereinstimmenden Kandidaten zurückgegeben.
Name Typ Beschreibung
totalPossibleCandidates Ganze Zahl Gibt die Gesamtzahl der möglichen Kandidaten an.
totalMatches Ganze Zahl Gibt die Gesamtzahl der Übereinstimmungen an.
candidates: Objekt vom Typ Candidate, das aus einem Array mit einem oder mehreren übereinstimmenden Kandidaten und zugehörigen Adress-, Vergleichs- und Standortinformationen zusammengesetzt ist Enthält die folgenden Elemente:
precisionLevel Ganze Zahl Ein Code, der die Genauigkeit des Geocodes angibt. Zur Auswahl stehen:
0
Es sind keine Koordinateninformationen zu dieser Adresse verfügbar.
1
Interpolierte Straßenanschrift.
2
Mittelpunkt des Straßensegments.
3
Mittelpunkt von Postleitzahl 1.
4
Mittelpunkt der Teil-Postleitzahl 2.
5
Mittelpunkt von Postleitzahl 2.
6
Kreuzung.
7
Point of Interest. (Wenn die Datenbank POI-Daten enthält.)
8
Bundesland-/Kantonmittelpunkt.
9
Bezirksmittelpunkt.
10
Ortsmittelpunkt.
11
Lokalitätsmittelpunkt.
12-15
Für unbestimmte benutzerdefinierte Elemente reserviert.
16
Das Ergebnis ist ein Adresspunkt.
17
Das Ergebnis wurde generiert, indem die Segmentdaten des Kandidaten mithilfe von Adresspunktdaten geändert wurden.
18
Das Ergebnis ist ein Adresspunkt, der mithilfe des Features „Versatz von Mittellinie“ projiziert wurde. Zur Verwendung des Features „Versatz von Mittellinie“ müssen Sie eine Punkt- und Straßenbereichsdatenbank haben.
Anmerkung: Dieses Feld wird für die USA nicht zurückgegeben. Informationen zur Geocode-Genauigkeit für die USA erhalten Sie unter Positionscodes.
formattedStreetAddress Zeichenfolge

Die formatierte Hauptadresszeile.
formattedLocationAddress Zeichenfolge Die formatierte letzte Adresszeile.
identifier Zeichenfolge Für Kandidaten auf Straßen- oder Punktebene ist dies in der Regel die Segment-ID.
precisionCode Zeichenfolge Ein Code, der die Genauigkeit des Geocodes angibt.

Das Format der Ergebniszeichenfolge des Geocodes lautet match_category[additional_match_information].

Die folgenden Vergleichskategorien sind möglich:

Z1
Postalischer Vergleich mit dem Mittelpunkt von Postleitzahl 1.
Z2
Postalischer Vergleich mit dem Mittelpunkt von Teil-Postleitzahl 2.
Z3
Postalischer Vergleich mit dem Mittelpunkt von Postleitzahl 2.
G1
Geografischer Vergleich mit dem Mittelpunkt von Gebietsname 1.
G2
Geografischer Vergleich mit dem Mittelpunkt von Gebietsname 2.
G3
Geografischer Vergleich mit dem Mittelpunkt von Gebietsname 3.
G4
Geografischer Vergleich mit dem Mittelpunkt von Gebietsname 4.

Die Übereinstimmungen in der Kategorie „S“ geben an, dass der Datensatz mit einem einzelnen Adresskandidaten übereinstimmte.

SX
Punkt, der sich an einer Straßenkreuzung befindet.
SC
Vergleichspunkt, der sich auf Hausebene befindet und aus dem nächstgelegenen Segment projiziert wurde.
S0
Es sind keine Koordinaten verfügbar, allerdings haben Teile der Adresse gegebenenfalls mit den Quelldaten übereingestimmt.
S4
Der Geocode befindet sich an einem Straßenmittelpunkt.
S5
Der Geocode befindet sich an einer Straßenanschrift.
S7
Der Geocode befindet sich an einer Straßenanschrift, die zwischen Standorten von Hauspunkten interpoliert wurde.
S8
Der Vergleichspunkt befindet sich am Hausstandort.
Weitere Vergleichsinformationen weisen das Format HPNTSCSZA auf. Wenn kein Vergleichsergebnis für die angegebene Komponente erzielt wurde, wird statt eines Buchstabens ein Strich (-) angezeigt.
H
Hausnummer.
P
Richtungsangabe für das Straßenpräfix.
N
Straßenname.
T
Straßentyp
S
Richtungsangabe für das Straßensuffix.
C
Ortsname.
Z
Postleitzahl.
A
Geocoding-Dataset.
U
Benutzerdefiniertes Benutzerwörterbuch.
Anmerkung: Ausführlichere Informationen, einschließlich landesspezifischer Bedeutungen und Werte, erhalten Sie unter Globale Ergebniscodes.
sourceDictionary Zeichenfolge Identifiziert das Wörterbuch, das die Quelle für die Kandidateninformationen und -daten ist. Bei dem Quellwörterbuch handelt es sich um einen nullbasierten Ganzzahlwert, der angibt, aus welchem konfigurierten Wörterbuch der Kandidat stammt. Wenn Sie nur ein einzelnes Wörterbuch haben, wird dieser Wert immer „0“ sein.
matching-Objekt. Gibt an, welche Teile der Eingabe übereinstimmten, bestehend aus den folgenden Elementen:
matchOnAddressNumber Boolean Gibt an, ob die eingegebene Adressnummer mit der Adressnummer des Kandidaten übereinstimmte.
True
Die eingegebene Adressnummer stimmte mit der Adressnummer des Kandidaten überein.
False
Die eingegebene Adressnummer stimmte nicht mit der Adressnummer des Kandidaten überein.
matchOnPostCode1 Boolean Gibt an, ob das Eingabefeld postCode1 mit dem Feld postCode1 des Kandidaten übereinstimmte.
True
Die Eingabe postCode1 stimmte mit dem postCode1 des Kandidaten überein.
False
Die Eingabe postCode1 stimmte nicht mit dem postCode1 des Kandidaten überein.
matchOnPostCode2 Boolean Gibt an, ob das Eingabefeld postCode2 (Erweiterung der Postleitzahl) mit dem Feld postCode2 des Kandidaten übereinstimmte.
True
Die Eingabe postCode2 stimmte mit dem postCode2 des Kandidaten überein.
False
Die Eingabe postCode2 stimmte nicht mit dem postCode2 des Kandidaten überein.
matchOnAreaName1 Boolean Gibt an, ob das Eingabefeld areaName1 mit dem Feld areaName1 des Kandidaten übereinstimmte.
True
Die Eingabe areaName1 stimmte mit dem areaName1 des Kandidaten überein.
False
Die Eingabe areaName1 stimmte nicht mit dem areaName1 des Kandidaten überein.
matchOnAreaName2 Boolean Gibt an, ob das Eingabefeld areaName2 mit dem Feld areaName2 des Kandidaten übereinstimmte.
True
Die Eingabe areaName2 stimmte mit dem areaName2 des Kandidaten überein.
False
Die Eingabe areaName2 stimmte nicht mit dem areaName2 des Kandidaten überein.
matchOnAreaName3 Boolean Gibt an, ob das Eingabefeld areaName3 mit dem Feld areaName3 des Kandidaten übereinstimmte.
True
Die Eingabe areaName3 stimmte mit dem areaName3 des Kandidaten überein.
False
Die Eingabe areaName3 stimmte nicht mit dem areaName3 des Kandidaten überein.
matchOnAreaName4 Boolean Gibt an, ob das Eingabefeld areaName4 mit dem Feld areaName4 des Kandidaten übereinstimmte.
True
Die Eingabe areaName4 stimmte mit dem areaName4 des Kandidaten überein.
False
Die Eingabe areaName4 stimmte nicht mit dem areaName4 des Kandidaten überein.
matchOnStreetName Boolean Gibt an, ob der eingegebene Straßenname mit dem Straßennamen des Kandidaten übereinstimmte.
True
Der eingegebene Straßenname stimmte mit dem Straßennamen des Kandidaten überein.
False
Der eingegebene Straßenname stimmte nicht mit dem Straßennamen des Kandidaten überein.
matchOnStreetType Boolean Gibt an, ob der eingegebene Straßentyp mit dem Straßentyp des Kandidaten übereinstimmte.
True
Der eingegebene Straßentyp stimmte mit dem Straßentyp des Kandidaten überein.
False
Der eingegebene Straßentyp stimmte nicht mit dem Straßentyp des Kandidaten überein.
matchOnStreetDirectional Boolean Gibt an, ob die eingegebene Richtungsangabe der Straße mit der Richtungsangabe der Straße des Kandidaten übereinstimmte.
True
Die eingegebene Richtungsangabe der Straße stimmte mit der Richtungsangabe der Straße des Kandidaten überein.
False
Die eingegebene Richtungsangabe der Straße stimmte nicht mit der Richtungsangabe der Straße des Kandidaten überein.
matchOnPlaceName Boolean Gibt an, ob der eingegebene Ortsname mit dem Ortsnamen des Kandidaten übereinstimmte.
True
Der eingegebene Ortsname stimmte mit dem Ortsnamen des Kandidaten überein.
False
Der eingegebene Ortsname stimmte nicht mit dem Ortsnamen des Kandidaten überein.
geometry-Objekt. Zurückgegebener Geocode, der die folgenden Elemente umfasst:
coordinates Double Der Geocode des Kandidaten, der als X-Koordinate (Längengrad) und Y-Koordinate (Breitengrad) angegeben wird, die durch ein Komma getrennt sind.
crs Zeichenfolge Das referenzierte Koordinatensystem, das für den Geocode des Kandidaten verwendet wird.
type Zeichenfolge Geometry-Typ. Der Rückgabewert lautet stets Point.
 
address-Objekt. Zurückgegebene Kandidatenadresse, die einige der folgenden Elemente enthalten kann:
mainAddressLine Zeichenfolge Adresszeile des Kandidaten.
addressLastLine Zeichenfolge Letzte Adresszeile des Kandidaten.
placeName Zeichenfolge Name der Firma, der Organisation, des Unternehmens oder Gebäudes.
areaName1 Zeichenfolge Bundesland, Kanton oder Region.
areaName2 Zeichenfolge Bezirk oder Landkreis.
areaName3 Zeichenfolge Ort, Stadt oder Vorort.
areaName4 Zeichenfolge Lokalität
postCode1 Zeichenfolge Hauptpostleitzahl.
postCode2 Zeichenfolge Sekundäre Postleitzahl, soweit vorhanden.
country Zeichenfolge Land
addressNumber Zeichenfolge Haus- oder Gebäudenummer.
streetName Zeichenfolge Straßenname.
unitType Zeichenfolge Der Typ der Einheit, z. B. Apt, Etage und Gebäude.
unitValue Zeichenfolge Der Wert/die Nummer der Einheit, z. B. „3B“.
customFields Objekt Die Felder und entsprechenden Rückgabewerte sind landesspezifisch. Informationen finden Sie in den Abschnitten Landesspezifische Informationen im Anhang.
ranges:CandidateRange-Objekt. Enthält Informationen zu den Bereichen eines Kandidaten, bestehend aus den folgenden Elementen:
placeName Zeichenfolge Gibt den Namen des Ortes oder Gebäudes des Kandidaten an, falls zutreffend.
lowHouse Zeichenfolge Gibt die niedrigste Hausnummer im Straßenbereich des Kandidaten an.
highHouse Zeichenfolge Gibt die höchste Hausnummer im Straßenbereich des Kandidaten an.
side Zeichenfolge Stellt Informationen zur Straßenseite zur Verfügung, auf der sich der Bereich des Kandidaten befindet.
LEFT
Der Bereich befindet sich auf der linken Seite der Straße.
RIGHT
Der Bereich befindet sich auf der rechten Seite der Straße.
BOTH
Der Bereich befindet sich auf der linken und rechten Seite der Straße.
UNKNOWN
Es sind keine Informationen zur Straßenseite verfügbar, auf der sich dieser Bereich befindet.
oddEvenIndicator Zeichenfolge Stellt Informationen zur Hausnummerierung des Kandidatenbereichs zur Verfügung.
ODD
Der Bereich umfasst ungerade Hausnummern.
EVEN
Der Bereich umfasst gerade Hausnummern.
BOTH
Der Bereich umfasst ungerade und gerade Hausnummern.
IRREGULAR
Der Bereich umfasst gerade und ungerade Hausnummern in einer unregelmäßigen Sortierung.
UNKNOWN
Es sind keine Informationen zur ungeraden/geraden Hausnummerierung für diesen Bereich verfügbar.
customValues Karte Eine Zuordnung lokaler Werte, die mit dem Kandidatenbereich verknüpft sind.
units:CandidateRangeUnit-Objekt. Enthält Informationen zu den Einheiten eines Kandidatenbereichs, bestehend aus den folgenden Elementen:
placeName Zeichenfolge Gibt den Namen des Ortes oder Gebäudes des Kandidaten an, falls zutreffend.
unitType Zeichenfolge Gibt den Einheitentyp an (z. B. APT, STE usw.).
highUnitValue Zeichenfolge Gibt die höchste Einheitennummer für diese Bereichseinheit an.
lowUnitValue Zeichenfolge Gibt die niedrigste Einheitennummer für diese Bereichseinheit an.
customValues Karte Eine Zuordnung lokaler Werte, die mit der Einheit verknüpft sind.