Información devuelta para el candidato

El conjunto estándar de campos que se pueden devolver incluye:

  • Coincidencias totales
  • Posibles candidatos totales
  • Dirección del candidato
  • Rango del candidato
  • Campos de coincidencia
  • Coordenadas de geocodificación (para la operación de geocodificación)
  • Códigos de resultado

La devolución de algunos de estos campos puede depender del tipo de datos proporcionado en el conjunto de datos de geocodificación configurado. Consulte la sección de cada país para obtener información sobre los campos de salida disponibles y sus definiciones. Además, algunos países tienen campos de salida personalizados. Consulte la sección de cada país en el Apéndice A - Información específica del país para obtener información sobre los campos de salida personalizados que están disponibles.

También tiene la opción de especificar la información adicional devuelta, como por ejemplo:

  • La cantidad máxima de candidatos que se devolverá.
  • Si se debe devolver toda la información disponible para cada candidato o solo los campos de dirección específicos. Estos campos adicionales se especifican mediante el uso de returnFieldsDescriptor. Están disponibles las siguientes opciones:
    • returnMatchDescriptor: devuelve el objeto descriptor de cruce, que indica las partes del candidato que coincidieron con la dirección de entrada.
    • returnStreetAddressFields: devuelve todos los campos de calles individuales que conforman el campo formattedStreetAddress de manera independiente, como la parte base de la dirección principal, el tipo de vía pública, cualquier elemento predireccional o posdireccional, etc.
    • returnUnitInformation: cuando está disponible, devuelve información del tipo de unidad y valor de unidad por separado en los campos unitType y unitValue, así como en el campo formattedStreetAddress.
    • returnAllCustomFields: devuelve todos los campos personalizados del candidato.
    • returnedCustomFieldKeys: especifica una lista de claves que representan los campos personalizados que se van a devolver en la salida customFields del candidato. Por ejemplo: “CTYST_KEY” o “DATATYPE”.
      Nota: Para especificar múltiples pares de clave/valor para un país, use espacios para separar los nombres de los campos personalizados que se devolverán. Aquellos candidatos que tengan la información de campo disponible incluirán los campos personalizados con las claves en la salida de customFields del candidato.
      Por ejemplo, en una solicitud de REST JSON:
      "preferences" : {
    "customPreferences" : {
      "USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY"
    }
}
      Nota: Los campos personalizados varía según el país. Para localizar la información de su país, consulte Información específica del país y busque la sección correspondiente en el apéndice, que proporciona más detalles.

Especificación de la información de retorno del candidato adicional en la API de REST

La API de REST Implementación de la función
Servicio: Geocode
Tipo de solicitud: POST
Objeto: Elemento preferences : returnFieldsDescriptor, donde la opción de campo adicional se especifica mediante un par de clave/valor. Se ignora si es verdadero.
Nota: Para anular el valor predeterminado de un elemento returnFieldsDescriptor para un país específico, especifique el par de clave/valor en el objeto customPreferences, con una constante de clave precedida por el código del país de 3 caracteres ISO-3166 más un punto. Por ejemplo:AUS.returnAllCustomFields.

Para obtener más información, consulteSolicitud POST de geocodificación.