Informations de renvoi de candidat

Le jeu de champs standard qui peut être renvoyé inclut les éléments suivants :

  • Nombre total de correspondances
  • Nombre total de candidats possibles
  • Adresse du candidat
  • Plage de candidats
  • Champs mis en correspondance
  • Coordonnées du géocode (pour l'opération de géocodage)
  • Codes de résultat

Le renvoi de certains de certains de ces champs dépend du type de données fourni dans le ou les jeux de géocodage configurés. Reportez-vous à la section de chaque pays pour plus d'informations sur les champs de sortie disponibles et leurs définitions. En outre, certains pays disposent de champs de sortie personnalisés. Reportez-vous à la section de chaque pays dans Annexe A - Informations spécifiques aux pays pour plus d'informations sur les champs de sortie personnalisés disponibles.

Vous avez également la possibilité de spécifier certaines des informations de renvoi, comme :

  • Le nombre maximal de candidats à renvoyer.
  • S'il faut renvoyer toutes les informations disponibles pour chaque candidat ou seulement renvoyer des champs d'adresse spécifiques. Ces champs supplémentaires sont définis à l'aide de returnFieldsDescriptor.. Les options suivantes sont disponibles :
    • returnMatchDescriptor - Renvoie l'objet descripteur de correspondance, qui indique les parties du candidat correspondant à l'adresse d'entrée.
    • returnStreetAddressFields - Renvoie tous les champs de rue individuels qui composent séparément le champ formattedStreetAddress, tels que la base de l'adresse principale, le type de voie publique, les éléments pré et/ou postdirectionnels, etc.
    • returnUnitInformation - Si disponible, renvoie les informations de type d'unité et de valeur d'unité séparément dans les champs unitType et unitValue, ainsi que dans le champ formattedStreetAddress.
    • returnAllCustomFields - Renvoie tous les champs personnalisés pour le candidat.
    • returnedCustomFieldKeys - Spécifie une liste de clés qui représentent les champs personnalisés à renvoyer dans la sortie customFields du candidat. Par exemple, « CTYST_KEY » ou « DATATYPE ».
      Remarque : Pour indiquer différents paires de clé/valeur pour un pays, utilisez des espaces pour séparer les noms des champs personnalisés à renvoyer. Les candidats possédant ces informations de champ disponibles incluent les champs personnalisés avec les clés dans la sortie customFields du candidat.
      Par exemple dans une requête REST JSON :
      "preferences" : {
    "customPreferences" : {
      "USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY"
    }
}
      Remarque : Les champs personnalisés varient selon le pays. Pour rechercher les informations de votre pays, reportez-vous à la section Informations spécifiques aux pays pour trouver la section correspondante de l'annexe qui fournit davantage de détails.

Indiquer des informations de renvoi de candidat supplémentaires dans l'API REST.

API REST Déploiement de fonction
Service : Geocode
Type de requête : POST
Objet : élément Préférences : returnFieldsDescriptor, où l'option de champ supplémentaire est spécifiée via une paire clé/valeur. Ignoré si isReturnAllCandidateInfo est défini sur true.
Remarque : Pour remplacer la valeur par défaut d'un élément returnFieldsDescriptor pour un pays en particulier, indiquez la paire clé/valeur dans l'objet customPreferences, avec la constante de clé précédée du code pays ISO-3166 de 3 caractères et d'un point. Par exemple, AUS.returnAllCustomFields..

Pour plus d'informations, reportez-vous à la section Requête POST vers le service Geocode.