Informationen zur Kandidatenrückgabe

Der standardmäßige Feldsatz, der zurückgegeben werden kann, umfasst:

  • Gesamtübereinstimmungen
  • Insgesamt mögliche Kandidaten
  • Kandidatenadresse
  • Kandidatenbereich
  • Verglichene Felder
  • Geocode-Koordinaten (für den Geocoding-Vorgang)
  • Ergebniscodes

Die Rückgabe einiger dieser Felder kann vom Typ der bereitgestellten Daten in den konfigurierten Geocoding-Datensets abhängen. Landesspezifische Informationen finden Sie im beigefügten Handbuch zum Global Geocoding-Modul. Informationen zu den verfügbaren Ausgabefeldern sowie den Definitionen für benutzerdefinierte Felder (falls vorhanden) finden Sie in den Abschnitten zu den einzelnen Ländern.

Sie haben ebenfalls die Möglichkeit, zusätzliche Rückgabeinformationen wie folgt anzugeben:

  • Legt die maximale Anzahl von zurückzugebenden Kandidaten fest.
  • Es gibt an, ob alle verfügbaren Informationen für jeden Kandidaten oder nur spezifische Adressfelder zurückgegeben werden sollen. Diese zusätzlichen Felder werden mithilfe von returnFieldsDescriptor angegeben. Die folgenden Optionen sind verfügbar:
    • returnMatchDescriptor: Gibt das Deskriptorobjekt der Übereinstimmung zurück. Dieses gibt die Teile des Kandidaten an, die mit der eingegebenen Adresse übereinstimmten.
    • returnStreetAddressFields: Gibt alle einzelnen Straßenfelder zurück, die das Feld formattedStreetAddress separat ausmachen. Dies sind u. a. der Basisteil der Hauptadressen, der Durchfahrtstyp, voran- oder nachgestellte Richtungsangaben usw.
    • returnUnitInformation: Soweit verfügbar gibt dieser Parameter Informationen zum Einheitstyp und Einheitswert einzeln in den Feldern unitType und unitValue sowie im Feld formattedStreetAddress zurück.
    • returnAllCustomFields: Gibt alle benutzerdefinierten Felder für den Kandidaten zurück.
    • returnedCustomFieldKeys: Gibt eine Liste von Schlüsseln an. Diese stellen die benutzerdefinierten Felder dar, die in der Ausgabe customFields des Kandidaten zurückgegeben werden sollen. Beispiel: „CTYST_KEY“ oder „DATATYPE“.
      Anmerkung: Um mehrere Schlüssel-Wert-Paare für ein Land anzugeben, trennen Sie die Namen der zurückzugebenden benutzerdefinierten Felder mit Leerzeichen. Kandidaten, bei denen diese Feldinformationen verfügbar sind, enthalten die benutzerdefinierten Felder mit den Schlüsseln in der customFields-Ausgabe des Kandidaten.
      Zum Beispiel in einer REST-JSON-Anforderung:
      "preferences" : {
    "customPreferences" : {
      "USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY"
    }
}
      Anmerkung: Benutzerdefinierte Felder unterscheiden sich von Land zu Land. Die für Ihr Land geltenden Informationen finden Sie im Abschnitt Landesspezifische Informationen im Anhang, in dem weitere Details aufgeführt werden.

Festlegen von zusätzlichen Kandidatenrückgabeinformationen in der REST-API

REST API Feature-Implementierung
Dienst: Geocode
Anforderungstyp: POST
Objekt:Element preferences : returnFieldsDescriptor, wobei die zusätzliche Feldoption mithilfe eines Schlüssel-Wert-Paares angegeben wird. Wird ignoriert, wenn isReturnAllCandidateInfo auf „true“ eingestellt ist.
Anmerkung: Um den Standardwert eines returnFieldsDescriptor-Elements für ein bestimmtes Land außer Kraft zu setzen, geben Sie das Schlüssel-Wert-Paar im Objekt customPreferences an, wobei vor der Schlüsselkonstanten der dreistellige ISO-3166-Ländercode mit einem Punkt steht. Beispiel: AUS.returnAllCustomFields..

Weitere Informationen finden Sie unter POST-Anforderung an Geocode.