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 comparación. Contiene los siguientes elementos:
precisionLevel Integer Un código que describe la precisión del código geográfico. Una de las siguientes:

0: No hay información de coordenadas disponible para esta dirección de candidato.                

1 Dirección de calle interpolada.

2 Punto medio de segmento de calle.

3 Centroide de código postal 1.

4 Centroide parcial de código postal 2.

5 Centroide de código postal 2.

6 Intersección.

7 Punto de interés. (Si la base de datos contiene datos de POI).

8 Centroide de estado/provincia.

9 Centroide de condado.

10 Centroide de ciudad.

11 Centroide de localidad.

12-15 Reservados para elementos personalizados sin especificar.

16 El resultado es un punto de dirección.

17 El resultado se generó mediante el uso de datos de puntos de dirección para modificar los datos de segmentos del candidato.

18 El resultado es un punto de dirección que se proyectó con la función de desplazamiento de la línea central. Debe tener una base de datos de rango de puntos y calles para utilizar la función de desplazamiento de línea central.
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 caracteres de resultado del código geográfico es match_category[additional_match_information].

Las posibles categorías de cruces son las siguientes:

Z1 Cruce postal con centroide de código postal 1.

Z2 Postal match with partial post code 2 centroid.

Z3 Cruce postal con centroide de código postal 2.

G1 Geographic match with area name 1 centroid.

G2 Cruce geográfico con centroide de nombre de área 2.

G3 Geographic match with area name 3 centroid.

G4 Cruce geográfico con centroide de nombre de área 4.

Los cruces de la categoría S indican que el registro se cruzó con un solo candidato de dirección.

SX Punto ubicado en una intersección de calles.

SC Match point located at the house level that has been projected from the nearest segment.

S0 No hay coordenadas disponibles, pero partes de la dirección pueden haber coincidido con los datos de origen.

S4 The geocode is located at a street centroid

S5 El código geográfico se encuentra en una dirección de calle.

S7 The geocode is located at a street address that has been interpolated between point house locations.

S8 Punto de cruce ubicado en una ubicación de casa.

La información de cruce adicional está en el formato HPNTSCSZA. Si no se pudo establecer un resultado de cruce para el componente especificado, aparecerá un guion (-) en lugar de una letra.

H Número de casa.

P Street prefix direction.

N Nombre de la calle.

T Street type.

S Sufijo direccional de calle.

C City name.

Z Código postal.

A Geocoding dataset.

U Conjunto de datos de usuario personalizado.
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.

True The input address number matched the candidate's address number.

Falso El número de dirección de entrada no 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.

True The input postCode1 matched the candidate's postCode1.

Falso El campo postCode1 de entrada no 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.

True The input postCode2 matched the candidate's postCode2.

False The input postCode2 did not match candidate's postCode2
matchOnAreaName1 Boolean Indica si el campo areaName1 de entrada coincidió con el campo areaName1 del candidato.

True The input areaName1 matched the candidate's areaName1.

False The input areaName1 did not match the candidate's areaName1.
matchOnAreaName2 Boolean Indica si el campo areaName2 de entrada coincidió con el campo areaName2 del candidato.

True The input areaName2 matched the candidate's areaName2.

False The input areaName2 did not match the candidate's areaName2.
matchOnAreaName3 Boolean Indica si el campo areaName3 de entrada coincidió con el campo areaName3 del candidato.

True The input areaName3 matched the candidate's areaName3.

False The input areaName3 did not match the candidate's areaName3.
matchOnAreaName4 Boolean Indica si el campo areaName4 de entrada coincidió con el campo areaName4 del candidato.

True The input areaName4 matched the candidate's areaName4.

False The input areaName4 did not match the candidate's areaName4.
matchOnCountry Boolean Indica si el país candidato coincide con el país de entrada.

True The candidate country matches the input country.

False The candidate country does not match the input country.
matchOnAllStreetFields Boolean Indica si todos los campos de calle de entrada coincidieron con todos los campos de calle del candidato.

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 Indica si el nombre de calle de entrada coincidió con el nombre de calle del candidato.

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 Indica si el tipo de calle de entrada coincidió con el tipo de calle del candidato.

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 Indica si la dirección de calle de entrada coincidió con la dirección de calle del candidato.

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 Indica si el nombre de lugar de entrada coincidió con el nombre de lugar del candidato.

True The input place name matched the candidate's place name.

False The input place name did not match the candidate's place name.
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:
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.
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.

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 Cadena Proporciona información sobre la numeración de casa del rango del candidato.

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 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.
totalPossibleCandidates Integer Indica cuántos candidatos de cruce se encontraron.