Solicitud GET de geocodificación

La solicitud GET le permite enviar una dirección de entrada y preferencias de comparación o geocodificación al servicio Geocode y recibir una respuesta que proporcione los objetos de candidatos que tengan las coordenadas de latitud y longitud asociadas, y otra información de comparación y ubicación acerca de cada candidato. Las preferencias de una solicitud GET son un subconjunto del total disponible con la solicitud POST. Cada par clave/valor está separado por un signo & (ampersand).

URI base

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

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

POST: mainAddressLine

GET: 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

Entrada de varias líneas: 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).

country Cadena Código de país ISO 3166-1 alpha-3. Obligatorio. Para conocer los códigos de los países, consulte Códigos de país ISO 3166-1.
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.

POST: postCode1

GET: postalCode

Cadena El código postal en el formato correspondiente al país. Opcional.

POST: postCode2

Cadena El código postal en el formato correspondiente al país. Opcional.
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

POST: addressLastLine

GET: lastLine

Cadena La última línea de la dirección. Opcional.
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.
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.
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.
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.
maxRanges Integer Un rango representa una serie de direcciones a lo largo de un segmento de calle. Por ejemplo, 5400-5499 Main St. representa un rango de direcciones en el bloque 5400 de Main St. Un rango puede representar solo direcciones impares o pares dentro de un segmento, o ambos tipos de direcciones. Un rango también puede representar una sola edificación con muchas unidades, como por ejemplo un edificio de departamentos.

Es esta opción especifica la cantidad máxima de rangos que se devolverán para cada candidato. Dado que el geocodificador devuelve un candidato por segmento, y un segmento puede incluir múltiples rangos, esta opción le permite ver los otros rangos en el segmento de un candidato.

Debe ser un valor entero. Default = 0.

maxRangeUnits Integer Esta opción especifica la cantidad máxima de unidades (por ejemplo, departamentos/apartamentos o suites) que se devolverán para cada candidato.

Por ejemplo, si geocodificara un edificio de oficinas en 65 Main St. que incluye cuatro suites, habría un máximo de cuatro unidades devueltas para el rango correspondiente al edificio: 65 Suite 1, 65 Suite 2, 65 Suite 3 y 65 Suite 4. Si para la cantidad máxima de unidades especifica el valor 2, solo se devolverán dos unidades en lugar de cuatro.

Debe ser un valor entero. Default = 0.

streetOffset Double La distancia de desplazamiento desde los segmentos de calle. La distancia se expresa en las unidades que haya especificado en la preferencia 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.

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.
streetOffsetUnits Cadena Unidad de medida para el desplazamiento de calle. Tiene uno de los siguientes valores: Pies, Metros (valor predeterminado).
cornerOffset Double Distancia para desplazar los puntos finales de calle en la comparación a nivel de calle. La distancia se expresa en las unidades que haya especificado en la preferencia 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 Unidad de medida para el desplazamiento de calle. Tiene uno de los siguientes valores: Pies, Metros (valor predeterminado).