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:
- 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
En la siguiente tabla se definen los parámetros de consulta GET para el servicio Geocode. Para obtener más información sobre la respuesta, consulte Objeto GeocodeServiceResponse.
Parámetro | Tipo | Descripción |
---|---|---|
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 |
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:
|
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.
|
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.
|
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:
|
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:
|