Objeto GeocodeServiceResponse
Una solicitud para el servicio Geocode devuelve un objeto GeocodeServiceResponse que incluye:
- totalPossibleCandidates: la cantidad total de posibles candidatos.
- totalMatches: la cantidad total de cruces.
- candidates: indica uno o más candidatos que coinciden con la o las direcciones de entrada. Para cada candidato, se muestra información sobre la ubicación y datos que coinciden.
Nombre | Tipo | Descripción |
---|---|---|
totalPossibleCandidates | Integer | Indica la cantidad total de posibles candidatos. |
totalMatches | Integer | Indica la cantidad total de coincidencias. |
candidates: objeto de tipo Candidate, que consta de una serie de uno o más candidatos de cruce y la dirección asociada, además de información sobre ubicación y cruce. Contiene los siguientes elementos: | ||
precisionLevel | Integer | Un código que describe la precisión del código geográfico. Las opciones son:
Nota: Este campo no se devuelve para EE. UU. Para ver información de precisión de la geocodificación para EE. UU., consulte Códigos de ubicación.
|
formattedStreetAddress | Cadena |
La línea principal de dirección con formato. |
formattedLocationAddress | Cadena | La última línea de dirección con formato. |
identifier | Cadena | Para candidatos de nivel de punto o calle, este normalmente es la ID de segmento. |
precisionCode | Cadena | Un código que describe la precisión del código geográfico. El formato de la cadena de resultado de geocodificación es Las posibles categorías de cruces son las siguientes:
Los cruces de la categoría S indican que el registro se cruzó con un solo candidato de dirección.
HPNTSCSZA . Si no se pudo establecer un resultado de cruce para el componente especificado, aparecerá un guión (-) en lugar de una letra.
Nota: Para obtener información detallada que incluya significados y valores específicos de cada país, consulte Códigos de resultado globales.
|
sourceDictionary | Cadena | Identifica el diccionario que es el origen de los datos y la información del candidato. El diccionario de origen es un valor entero basado en 0 que indica desde qué diccionario configurado proviene el candidato. Si solo tiene un diccionario, este siempre corresponderá a "0". |
Objeto matching. Indica qué partes de los datos de entrada coincidieron; consta de los siguientes elementos: | ||
matchOnAddressNumber | Boolean | Indica si el número de dirección de entrada coincidió con el número de dirección del candidato.
|
matchOnPostCode1 | Boolean | Indica si el campo postCode1 de entrada coincidió con el campo postCode1 del candidato.
|
matchOnPostCode2 | Boolean | Indica si el campo postCode2 de entrada (extensión de código postal) coincidió con el campo postCode2 del candidato.
|
matchOnAreaName1 | Boolean | Indica si el campo areaName1 de entrada coincidió con el campo areaName1 del candidato.
|
matchOnAreaName2 | Boolean | Indica si el campo areaName2 de entrada coincidió con el campo areaName2 del candidato.
|
matchOnAreaName3 | Boolean | Indica si el campo areaName3 de entrada coincidió con el campo areaName3 del candidato.
|
matchOnAreaName4 | Boolean | Indica si el campo areaName4 de entrada coincidió con el campo areaName4 del candidato.
|
matchOnStreetName | Boolean | Indica si el nombre de calle de entrada coincidió con el nombre de calle del candidato.
|
matchOnStreetType | Boolean | Indica si el tipo de calle de entrada coincidió con el tipo de calle del candidato.
|
matchOnStreetDirectional | Boolean | Indica si la dirección de calle de entrada coincidió con la dirección de calle del candidato.
|
matchOnPlaceName | Boolean | Indica si el nombre de lugar de entrada coincidió con el nombre de lugar del candidato.
|
Objeto geométrico. Código geográfico devuelto que consta de los siguientes elementos: | ||
coordinates | Double | El código geográfico del candidato, especificado como coordenadas x (longitud), y (latitud), separadas por una coma. |
crs | Cadena | El sistema de referencia de coordenadas utilizado para el código geográfico del candidato. |
type | Cadena | Tipo de geometría. El valor devuelto es siempre Point . |
Objeto dirección. Dirección del candidato devuelto, que puede incluir alguno de los siguientes elementos: | ||
Nota: El significado, los valores válidos y la compatibilidad de los siguientes elementos de dirección varían según el país:
Además, existen ciertas opciones de geocodificación y comparación que varían según el país. Es importante revisar la información específica de su país o sus países. Para localizar la información de su país, consulte la sección Información específica del país en el apéndice. |
||
mainAddressLine | Cadena | Línea de dirección del candidato. |
addressLastLine | Cadena | Última línea de dirección del candidato. |
placeName | Cadena | Nombre de firma, empresa, organización, comercial o edificio. |
areaName1 | Cadena | Estado, provincia o región. |
areaName2 | Cadena | Condado o distrito. |
areaName3 | Cadena | Ciudad, pueblo o suburbio. |
areaName4 | Cadena | Locality |
postCode1 | Cadena | Código postal principal. |
postCode2 | Cadena | Código postal secundario, si hay uno. |
country | Cadena | Country |
addressNumber | Cadena | El número de casa o de edificio. |
streetName | Cadena | Nombre de la calle. |
unitType | Cadena | El tipo de unidad, por ejemplo, Apt., Ste. y Bldg. |
unitValue | Cadena | El número o valor de la unidad, por ejemplo, "3B". |
customFields | Objeto | Los campos y valores correspondientes devueltos son específicos del país. Consulte la sección Información específica del país en el apéndice. |
rangos: objeto CandidateRange. Contiene información sobre los rangos del candidato, que consisten en los siguientes elementos: | ||
placeName | Cadena | Si corresponde, indica el nombre del edificio o lugar del candidato. |
lowHouse | Cadena | Indica el número bajo de casa en el rango de calle del candidato. |
highHouse | Cadena | Indica el número alto de casa en el rango de calle del candidato. |
side | Cadena | Proporciona información sobre el lado de la calle donde se encuentra ubicado el rango del candidato.
|
oddEvenIndicator | Cadena | Proporciona información sobre la numeración de casa del rango del candidato.
|
customValues | Mapa | Un mapa de valores locales relacionados con el rango del candidato. |
unidades: objeto CandidateRangeUnit. Contiene información sobre las unidades del rango del candidato, que consisten en los siguientes elementos: | ||
placeName | Cadena | Si corresponde, indica el nombre del edificio o lugar del candidato. |
unitType | Cadena | Indica el tipo de unidad (APT, STE, etc.). |
highUnitValue | Cadena | Indica el número de unidad alto de esta unidad de rango. |
lowUnitValue | Cadena | Indica el número de unidad bajo de esta unidad de rango. |
customValues | Mapa | Un mapa de valores locales relacionados con la unidad. |