Solicitud POST de geocodificación
La solicitud POST le permite enviar una dirección de entrada única o una lista de direcciones para un procesamiento por lotes. Las preferencias de cruce o geocodificación se pueden especificar de forma opcional para el servicio de Geocode y recibir las coordenadas asociadas de latitud/longitud y la información de ubicación. Las opciones de preferencia de una solicitud POST son el conjunto completo de opciones disponibles.
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.
Parámetros de la solicitud
- addresses: las direcciones que se van a geocodificar. Obligatorio.
- type: el tipo de código geográfico. Opcional.
- preferences: las opciones de geocodificación y comparación. Opcional.
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:
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. |
||
addresses serie de objetos Address. La serie de direcciones puede incluir una o más direcciones de entrada. Cada objeto de Address puede incluir los siguientes elementos: | ||
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. |
postCode1 | Cadena | El código postal en el formato correspondiente al país. Opcional. |
postCode2 | Cadena | La extensión del 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. |
addressNumber | Cadena | El número de casa o de edificio. |
streetName | Cadena | Nombre de la calle. |
unitType | Cadena | Especifica el tipo de unidad, por ejemplo, Apt., Ste. y Bldg. |
unitValue | Cadena | Especifica el número o valor de la unidad, por ejemplo, "3B". |
objeto type de tipo geocodeType: | ||
geocodeType | Cadena |
Indica el tipo de código geográfico que se va a realizar. Opcional.
|
objeto preferences de tipo Preferences, que consiste en los siguientes elementos. Nota: Los siguientes elementos solo se aplican al servicio de Geocode.
Nota: Para anular el valor predeterminado de un elemento preferences para un país específico, especifique el par de clave/valor en el objeto customPreferences, con la constante de clave precedida por el código del país de 3 caracteres ISO-3166 más un punto. Por ejemplo: "
DEU.fallbackToGeographic ". |
||
returnAllCandidateInfo | Boolean | Especifica si se debe devolver toda la información disponible para cada candidato.
|
fallbackToGeographic | 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.
|
fallbackToPostal | 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.
|
FALLBACK_TO_WORLD | Cadena | Especifica si se debe usar World Geocoder (XWG) para determinar un código geográfico si el geocodificador de un país no está instalado o si se instaló sin un conjunto de datos de geocodificación. El World Geocoder (XWG) puede devolver un geocódigo postal o geográfico, según el nivel de soporte en el conjunto de datos de la geocodificación de XWG. Opcional.
|
maxReturnedCandidates | 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:
|
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:
|
clientCoordSysName | Cadena | Especifica el sistema de coordenadas al que se desea convertir la geometría. El formato debe ser el del código EPSG (European Petroleum Survey Group) o el código SRID. Opción predeterminada = EPSG:4326 . Especifique el sistema de referencia de coordenadas en el formato |
customPreferences | Map<String key, String value> | Especifica las preferencias de entrada específicas del país. Este objeto se puede usar para especificar:
Para anular el valor predeterminado de un país específico, preceda la constante de clave con el código del país de 3 caracteres ISO-3166 más un punto, y luego especifique el valor. Por ejemplo, en una solicitud XML, la entrada de una anulación de un país se vería así:
Las opciones de entrada personalizadas del país se encuentran disponibles para los siguientes países:
|
preferredDictionaryOrder | List<String> | Especifica el orden de búsqueda del diccionario cuando existen varios diccionarios instalados. El orden de búsqueda predeterminado es el orden en que se configuran los diccionarios. |
Objeto mustMatchFields de tipo FieldsMatching. Permite configurar los criterios para determinar los candidatos de coincidencia. Para activar estas opciones, debe configurar el campo matchMode en Custom. Este objeto consta de los siguientes elementos: Nota: Para anular el valor predeterminado de un elemento mustMatchFields para un país específico, especifique el par de clave/valor en el objeto customPreferences, con una constante de clave precedida por el código del país de 3 caracteres ISO-3166 más un punto. Por ejemplo: "
CAN.matchOnAddressNumber ". |
||
matchOnAddressNumber | Boolean |
|
matchOnPostCode1 | Boolean |
|
matchOnAreaName1 | Boolean |
|
matchOnAreaName2 | Boolean |
Nota: Esta opción no es compatible en EE. UU.
|
matchOnAreaName3 | Boolean |
|
matchOnAreaName4 | Boolean |
|
matchOnAllStreetFields | Boolean |
|
mustMatchInput | Boolean |
|
Objeto returnFieldsDescriptor de tipo ReturnsFieldsDescriptor. Controla la devolución de datos adicionales en un candidato. En forma predeterminada, la información ampliada del candidato no se devuelve, pero en los casos en que hay más disponible, se puede controlar de las siguientes maneras: Nota: Para anular el valor predeterminado de un elemento returnFieldsDescriptor para un país específico, especifique el par de clave/valor en el objeto customPreferences, con una constante de clave precedida por el código del país de 3 caracteres ISO-3166 más un punto. Por ejemplo: "
AUS.returnAllCustomFields ". |
||
returnAllCustomFields | Boolean |
|
returnedCustomFieldKeys | List<String> | Especifica una lista de claves que representan los campos personalizados que se van a devolver en la salida customFields del candidato. Por ejemplo: "CTYST_KEY " o "DATATYPE ". Valor predeterminado: vacíoNota: Para especificar múltiples pares de clave/valor para un país, use espacios para separar los nombres de los campos personalizados que se devolverán. Por ejemplo:
"USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY" . Aquellos candidatos que tengan esta información disponible incluirán los tres campos personalizados con estas claves en la salida customFields del candidato.Nota: Los campos personalizados varía según el país. Para localizar la información de su país, consulte Información específica del país y busque la sección correspondiente en el apéndice, que proporciona más detalles.
|
returnMatchDescriptor | Boolean |
|
returnStreetAddressFields | Boolean |
|
returnUnitInformation | Boolean |
|