GeocodeServiceResponse-Objekt
- 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 für diese Kandidatenadresse verfügbar. 1 Interpolierte Straßenadresse2 Mittelpunkt des Straßensegments 3 Mittelpunkt von Postleitzahl 14 Teilweiser Mittelpunkt von Postleitzahl 2 5 Mittelpunkt von Postleitzahl 26 Kreuzung 7 Point of Interest (Wenn die Datenbank POI-Daten enthält.)8 Mittelpunkt des Bundeslandes oder der Region 9 Mittelpunkt des Bezirks10 Mittelpunkt der Stadt 11 Mittelpunkt des Ortes12–15 Für nicht spezifizierte benutzerdefinierte Objekte 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 der Funktion „Mittellinienversatz“ projiziert wurde. Zur Verwendung der Funktion „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 Die folgenden Vergleichskategorien sind möglich: Z1 Postalischer Vergleich mit dem Mittelpunkt von Postleitzahl 1.Z2 Postal match with partial post code 2 centroid. Z3 Postalischer Vergleich mit dem Mittelpunkt von Postleitzahl 2.G1 Geographic match with area name 1 centroid. G2 Geografischer Vergleich mit dem Mittelpunkt von Gebietsname 2.G3 Geographic match with area name 3 centroid. 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 Match point located at the house level that has been projected from the nearest segment. S0 Es sind keine Koordinaten verfügbar, allerdings haben Teile der Adresse gegebenenfalls mit den Quelldaten übereingestimmt.S4 The geocode is located at a street centroid S5 Der Geocode befindet sich an einer Straßenanschrift.S7 The geocode is located at a street address that has been interpolated between point house locations. S8 Der Vergleichspunkt befindet sich am Hausstandort.Weitere Vergleichsinformationen weisen das Format P Street prefix direction. N StraßennameT Street type. S Straßenrichtung als SuffixC City name. Z PostleitzahlA Geocoding dataset. U Benutzerdefiniertes Benutzer-Dataset.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 The input address number matched the candidate's address number. 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 The input postCode1 matched the candidate's postCode1. 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 The input postCode2 matched the candidate's postCode2. False The input postCode2 did not match candidate's postCode2 |
matchOnAreaName1 | Boolean | Gibt an, ob das Eingabefeld areaName1 mit dem Feld areaName1 des Kandidaten übereinstimmte. True The input areaName1 matched the candidate's areaName1. False The input areaName1 did not match the candidate's areaName1. |
matchOnAreaName2 | Boolean | Gibt an, ob das Eingabefeld areaName2 mit dem Feld areaName2 des Kandidaten übereinstimmte. True The input areaName2 matched the candidate's areaName2. False The input areaName2 did not match the candidate's areaName2. |
matchOnAreaName3 | Boolean | Gibt an, ob das Eingabefeld areaName3 mit dem Feld areaName3 des Kandidaten übereinstimmte. True The input areaName3 matched the candidate's areaName3. False The input areaName3 did not match the candidate's areaName3. |
matchOnAreaName4 | Boolean | Gibt an, ob das Eingabefeld areaName4 mit dem Feld areaName4 des Kandidaten übereinstimmte. True The input areaName4 matched the candidate's areaName4. False The input areaName4 did not match the candidate's areaName4. |
matchOnCountry | Boolean | Gibt an, ob das Kandidatenland mit dem Eingabeland übereinstimmt. True The candidate country matches the input country. False The candidate country does not match the input country. |
matchOnAllStreetFields | Boolean | Gibt an, ob alle eingegebenen Straßenfelder mit allen Straßenfeldern des Kandidaten übereinstimmen. True All of the input street fields matched all of the candidate's street fields. False One or more of the input street fields do not match the candidate's street fields. |
matchOnStreetName | Boolean | Gibt an, ob der eingegebene Straßenname mit dem Straßennamen des Kandidaten übereinstimmte. True The input street name matched the candidate's street name. False The input street name did not match the candidate's street name. |
matchOnStreetType | Boolean | Gibt an, ob der eingegebene Straßentyp mit dem Straßentyp des Kandidaten übereinstimmte. True The input street type matched the candidate's street type. False The input street type did not match the candidate's street type. |
matchOnStreetDirectional | Boolean | Gibt an, ob die eingegebene Richtungsangabe der Straße mit der Richtungsangabe der Straße des Kandidaten übereinstimmte. True The input street directional matched the candidate's street directional. False The input street directional did not match the candidate's street directional. |
matchOnPlaceName | Boolean | Gibt an, ob der eingegebene Ortsname mit dem Ortsnamen des Kandidaten übereinstimmte. True The input place name matched the candidate's place name. False The input place name did not match the candidate's place name. |
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 | Geometrietyp. 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. |
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 The range is on the left side of the street. RIGHT The range is on the right side of the street. BOTH The range is on both the left and right side of the street. UNKNOWN No information is available on the side of the street this range is located. |
oddEvenIndicator | Zeichenfolge | Stellt Informationen zur Hausnummerierung des Kandidatenbereichs zur Verfügung. ODD The range contains odd house numbers. EVEN The range contains even house numbers. BOTH The range contains both odd and even house numbers. IRREGULAR The range contains both even and odd numbers in an irregular order. UNKNOWN No information is available on the odd/even house numbering on this range. |
customValues | Mapping | Ein Mapping 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 | Mapping | Ein Mapping lokaler Werte, die mit der Einheit verknüpft sind. |
totalPossibleCandidates | Ganze Zahl | Gibt an, wie viele übereinstimmende Kandidaten gefunden wurden. |