Solicitud GET de geocodificación

La solicitud GET le permite enviar una dirección de entrada y preferencias de cruce o geocodificación hacia el servicio Geocode y recibir una respuesta que proporciona los objetos de candidatos que contienen las coordenadas de latitud y longitud asociadas y otra información de cruce y ubicación acerca de cada candidato. Las opciones de preferencia de una solicitud GET son un subconjunto del total disponible con la solicitudPOST.

URI base

http://<server>:<port>/rest/GlobalGeocode/geocode.[content type]

Donde:

.[content type] indica que el tipo de contenido especificado se usará de manera predeterminada. Opcional.
json
El tipo de contenido predeterminado es JSON, salvo que la negociación de contenido HTTP lo sustituya
xml
El tipo de contenido predeterminado es XML, salvo que la negociación de contenido HTTP lo sustituya

Los [parámetros de consulta] se describen en la siguiente sección. Cada par de clave/valor ingresado en la solicitud se separa por un carácter &.

Parámetros de consulta

La siguiente tabla define los parámetros de consulta GET para el servicioGeocode. Para obtener más información sobre la respuesta, consulte Objeto GeocodeServiceResponse.

Parámetro Tipo Descripción
Nota: El significado, los valores válidos y la compatibilidad de los siguientes elementos de dirección varían según el país:
  • placeName
  • mainAddress
  • lastLine
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2
  • country

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.
placeName Cadena Nombre del edificio, nombre del lugar, punto de interés (POI), nombre de empresa o firma relacionada con la dirección de entrada. Opcional. Por ejemplo:

Pitney Bowes
4750 Walnut St.
Boulder, CO 80301
mainAddress Cadena Entrada en una sola línea: si ningún otro campo está completado, la entrada mainAddress se considerará como una entrada en una sola línea y puede ser una recopilación de elementos del campo de dirección. El orden de entrada de los campos de dirección debe reflejar el formato normal de la dirección de su país. Opcional. Por ejemplo:

4750 Walnut St., Boulder CO, 80301

Dirección de calle: si los campos de dirección (placeName, lastLine, postalCode, etc.) se proporcionan independientemente, el contenido de este campo se considerará como parte de la dirección de calle y puede incluir el nombre de la empresa, el número de casa, los nombres de edificios y los nombres de calles. Opcional.

Entrada de intersección de calles: para ingresar una intersección, especifique los nombres de las dos calles separados por el carácter "&&" (ampersand doble).
lastLine Cadena La última línea de la dirección. Opcional.
areaName1 Cadena Especifica el área geográfica más grande, normalmente un estado o una provincia. Opcional.
areaName2 Cadena Especifica el área geográfica secundaria, normalmente un condado o distrito. Opcional.
areaName3 Cadena Especifica un nombre de la ciudad o el pueblo. Opcional.
areaName4 Cadena Especifica una localidad o subdivisión de la ciudad. Opcional.
postalCode Cadena El código postal en el formato correspondiente al país. Opcional.
country Cadena Código de país ISO 3166-1 alpha-3. Obligatorio. Para conocer los códigos de los países, consulte Lista de referencia del país y códigos de país ISO 3166-1.
matchMode Cadena Los modos de coincidencia determinan la poca severidad usada para realizar una coincidencia entre la dirección de entrada y los datos de referencia. Seleccione un modo de cruce a partir de la calidad de sus datos de entrada y los datos de salida que desee. Están disponibles los siguientes modos de cruce:
Exact
Requiere un cruce muy ajustado. Este modo restrictivo genera la menor cantidad de candidatos de cruce, lo que he disminuye el tiempo de procesamiento. Cuando se utilice este modo, asegúrese de que sus datos de entrada estén muy limpios, sin errores ortográficos y direcciones incompletas.
Standard
Requiere un cruce cercano y genera una cantidad moderada de candidatos de cruce. Opción predeterminada.
Relaxed
Permite un cruce impreciso y genera la mayor cantidad de candidatos de cruce, lo que aumenta el tiempo de procesamiento y da como resultado múltiples coincidencias. Utilice este modo si no está seguro de que sus datos de entrada estén limpios, sin errores ortográficos y direcciones incompletas.
Custom
Le ofrece la capacidad de definir los criterios de comparación mediante el establecimiento de campos MustMatch; sin embargo, los campos MustMatch solo se pueden establecer mediante el uso de una solicitud POST. Para una solicitud GET, se usan los valores predeterminados MustMatch. Para obtener más información sobre los campos MustMatch, consulte mustMatchFields.
Interactive (USA only)
Disponible únicamente en coincidencia con dirección de una línea. Este modo está diseñado para gestionar mejor los desafíos de coincidencia específicos que se presentan en el cruce interactivo. El modo interactivo permite patrones de coincidencia más flexibles y puede, en algunos casos, devolver posibles coincidencias adicionales que el modo de cruce relajado.
CASS (USA only)
Impone reglas adicionales para garantizar el cumplimiento de la normativa de USPS para CASS. El propósito de este modo de cruce es crear direcciones a las que se pueden enviar correos para descuentos de correo de USPS. Utilice este modo para estandarizar sus datos de entrada de correo. Este modo genera una gran cantidad de candidatos de cruce.
fallbackGeo Boolean Indica si se intentará determinar el centroide de una región geográfica cuando no sea posible determinar un código geográfico de nivel de dirección. Opcional.
True
Devuelve un centroide geográfico si no es posible determinar un centroide de nivel de dirección. Opción predeterminada.
False
No devuelve un centroide geográfico si no es posible determinar un centroide de nivel de dirección.
fallbackPostal Boolean Especifica si se intentará determinar un centroide de código postal cuando no sea posible definir una geocodificación de nivel de dirección. Opcional.
True
Devuelve un centroide de código postal si no es posible determinar un centroide de nivel de dirección. Opción predeterminada.
False
No devuelve un centroide de código postal si no es posible determinar un centroide de nivel de dirección.
maxCands Integer La cantidad máxima de candidatos que se deben devolver. Opcional. Debe ser un valor entero. Default = 1.
streetOffset Double Indica la distancia de desplazamiento desde los segmentos de calle que se aplicará en la geocodificación de nivel de calle. La distancia se especifica en las unidades que se hayan especificado en la opción streetOffsetUnits. Valor predeterminado = 7 metros.

La distancia de desplazamiento se utiliza en la geocodificación de nivel de calle para evitar que el código geográfico esté en el medio de una calle. Compensa el hecho de que la geocodificación de nivel de calle devuelve un punto de latitud y longitud en el centro de la calle donde se ubica la dirección. Dado que el edificio representado por una dirección no está en la calle misma, el código geográfico de una dirección no debe ser un punto en la calle, sino que debe representar la ubicación del edificio que está junto a la calle. Por ejemplo, un desplazamiento de 50 pies (15,24 m) significa que el código geográfico representará un punto ubicado a 50 pies (15,24 m) del centro de la calle. La distancia se calcula de forma perpendicular a la parte del segmento de calle correspondiente a la dirección. El desplazamiento también se utiliza para evitar que a las direcciones de lados opuestos de la calle se les asigne el mismo punto. El siguiente diagrama muestra un punto desplazado en relación con el punto original.
streetOffsetUnits Cadena Especifica la unidad de medida para el desplazamiento de calle. Una de las siguientes:
  • Feet
  • Meters - Default
cornerOffset Double Especifica la distancia para desplazar los puntos de fin de calle en la comparación de nivel de calle. La distancia se especifica en las unidades que se hayan especificado en la opción cornerOffsetUnits. Este valor se usa para evitar que las direcciones en las esquinas de las calles reciban el mismo código geográfico que la intersección. Define la posición de desplazamiento del punto geocodificado, en relación con la esquina. Valor predeterminado = 7 metros.

El siguiente diagrama compara los puntos finales de una calle con los puntos finales de desplazamiento.
cornerOffsetUnits Cadena Especifica la unidad de medida para el desplazamiento de esquina. Una de las siguientes:
  • Feet
  • Meters - Default