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:
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 Die folgenden Vergleichskategorien sind möglich:
Die Übereinstimmungen in der Kategorie „S“ geben an, dass der Datensatz mit einem einzelnen Adresskandidaten übereinstimmte.
HPNTSCSZA auf. Wenn kein Vergleichsergebnis für die angegebene Komponente erzielt wurde, wird statt eines Buchstabens ein Strich (-) angezeigt.
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.
|
matchOnPostCode1 | Boolean | Gibt an, ob das Eingabefeld postCode1 mit dem Feld postCode1 des Kandidaten übereinstimmte.
|
matchOnPostCode2 | Boolean | Gibt an, ob das Eingabefeld postCode2 (Erweiterung der Postleitzahl) mit dem Feld postCode2 des Kandidaten übereinstimmte.
|
matchOnAreaName1 | Boolean | Gibt an, ob das Eingabefeld areaName1 mit dem Feld areaName1 des Kandidaten übereinstimmte.
|
matchOnAreaName2 | Boolean | Gibt an, ob das Eingabefeld areaName2 mit dem Feld areaName2 des Kandidaten übereinstimmte.
|
matchOnAreaName3 | Boolean | Gibt an, ob das Eingabefeld areaName3 mit dem Feld areaName3 des Kandidaten übereinstimmte.
|
matchOnAreaName4 | Boolean | Gibt an, ob das Eingabefeld areaName4 mit dem Feld areaName4 des Kandidaten übereinstimmte.
|
matchOnStreetName | Boolean | Gibt an, ob der eingegebene Straßenname mit dem Straßennamen des Kandidaten übereinstimmte.
|
matchOnStreetType | Boolean | Gibt an, ob der eingegebene Straßentyp mit dem Straßentyp des Kandidaten übereinstimmte.
|
matchOnStreetDirectional | Boolean | Gibt an, ob die eingegebene Richtungsangabe der Straße mit der Richtungsangabe der Straße des Kandidaten übereinstimmte.
|
matchOnPlaceName | Boolean | Gibt an, ob der eingegebene Ortsname mit dem Ortsnamen des Kandidaten übereinstimmte.
|
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: | ||
Anmerkung: Die Bedeutung, die gültigen Werte und die Unterstützung der folgenden Adresselemente sind von Land zu Land unterschiedlich:
Außerdem sind einige Vergleichs- und Geocoding-Optionen vorhanden, die von Land zu Land unterschiedlich sind. Die für Ihr Land/Ihre Länder spezifischen Informationen sind unbedingt zu überprüfen. Einzelheiten finden Sie im Handbuch Globales Geocodierungsmodul. |
||
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.
|
oddEvenIndicator | Zeichenfolge | Stellt Informationen zur Hausnummerierung des Kandidatenbereichs zur Verfügung.
|
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. |