Solicitud POST de geocodificación inversa

La solicitud POST le permite enviar una coordenada de entrada o una lista de coordenadas para un procesamiento por lotes. Opcionalmente también se puede especificar un código de país, un sistema de referencia de coordenadas y las preferencias de comparación. Se devuelve una respuesta que incluye una lista de candidatos con los datos de dirección relacionados y la información de cruce. Las opciones de preferencia de una solicitud POST son el conjunto completo de las opciones disponibles.

URI base

http://<server>:<port>/rest/GlobalGeocode/reverseGeocode.[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

Parámetros de la solicitud

La solicitud POST consta de los siguientes parámetros de entrada:

points: Las coordenadas de entrada que se van a someter a geocodificación inversa. Obligatorio.
preferences: Las opciones de comparación. Opcional.

Estos objetos y sus elementos se definen en la siguiente tabla.

Nombre	Tipo	Descripción
points un objeto de matriz que contiene un objeto geométrico y una cadena de código del país:
country	Cadena	Indica el país para buscar el resultado de la geocodificación inversa, especificado mediante el uso de un código de país ISO de 3 letras. Opcional. 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.
Objeto geometry , consiste en los siguientes elementos:
coordinates	Double	Especifica las coordenadas de entrada x, y, donde x=longitud, y = latitud. Por ejemplo: [ -105.25175, 40.024494 ]
type	Cadena	Indica el tipo de entidad geográfica que representan las coordenadas de entrada. point Las coordenadas de entrada representan una ubicación de punto.
crs	Cadena	Indica el sistema de referencia de coordenadas utilizado para las coordenadas de entrada. 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 codespace:code.
Objeto preferences, consiste en los siguientes elementos. Nota: Solo los siguientes elementos en el objeto preferencias se pueden aplicar al servicio Reverse 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.streetOffset`.
distance	Double	Establece el radio en el cual el servicio de geocodificación inversa busca una coincidencia con las coordenadas de entrada. La unidad de medida se especifica por medio de . Valor predeterminado = 150 metros. Valor máximo = 5280 pies (1 milla) o 1609 metros.
distanceUnits	Cadena	Especifica la unidad de medida para la distancia de búsqueda. Una de las siguientes: Feet Meters - Default
clientLocale	Cadena	Este campo se utiliza para un país que tiene varios idiomas, a fin de determinar el orden preferido para los candidatos de idioma. La configuración regional se debe especificar en el formato “cc_CC”, donde “cc” es el idioma y “CC” es el código ISO 3166-1 Alpha-2, como: en-US, fr_CA o fr_FR. Por ejemplo, Egipto admite inglés y árabe. El campo clientLocale se puede definir con el inglés primero (en-EN) o el árabe primero (ar-EG). Nota: Para acceder a una lista de códigos de países ISO Alpha-2, consulte Lista de referencia del país y códigos de país ISO 3166-1.
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 `codespace:code`.
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
customPreferences	Map<String key, String value>	Especifica las preferencias de entrada específicas del país. Este objeto se puede usar para especificar: La anulación de un país a un valor predeterminado de uno o más elementos en los objetos preferencias o returnFieldsDescriptor. Una opción de entrada personalizada de un país. Para anular el valor predeterminado de un país específico, preceda la constante de clave con el código del país ISO-3 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í: `<customPreferences> <entry> <key>CAN.distance</key> <value>300</value> </entry> </customPreferences>` Las opciones de entrada personalizadas del país se encuentran disponibles para los siguientes países: Australia (AUS) Canadá (CAN) Francia (FRA) Alemania (DEU) Gran Bretaña (GBR) Nueva Zelanda (NZL) Portugal (PRT) Singapur (SGP) Suecia (SWE) Estados Unidos (USA) Además, para los países que admiten diccionarios de usuario personalizados y conjuntos de datos de geocodificación estándar, puede establecer una preferencia personalizada con la clave KEY_CUSTOM_DICTIONARY_USAGE, la cual definirá las preferencias de búsqueda y cruce cuando tanto el diccionario estándar como el personalizado estén disponibles en el motor de geocodificación. Esta opción solo se encuentra disponible para geocodificación directa. Para obtener más información, consulteConfiguración de las preferencias de búsqueda y coincidencia cuando se usan diccionarios estándar y personalizados. Para saber si su país admite diccionarios de usuario personalizados, consulte la sección "Conjuntos de datos de geocodificación admitidos" en la reseña del país.
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	True Devuelve todos los campos personalizados del candidato. False Devuelve solo el conjunto de campos estándar para el candidato. Opción predeterminada.
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ío Nota: 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	True Devuelve el objeto descriptor de cruce, que indica las partes del candidato que coincidieron con la dirección de entrada. False No devuelve el objeto descriptor de cruce. Opción predeterminada.
returnStreetAddressFields	Boolean	True Devuelve todos los campos de calle individuales que conforman el campo formattedStreetAddress de forma independiente, de la siguiente manera: MAIN_ADDRESS: la parte principal del nombre de la calle. Por ejemplo: “River” en “13 River Ave” THOROUGHFARE_TYPE: el tipo de vía, que puede aparecer antes o después del nombre de la calle, como Ave, Via, St, Rd, etc. ADDRESS_ID: el identificador único para la dirección en los datos de origen. PRE_ADDRESS: el valor puede contener artículos, etc. que aparezcan antes del nombre principal de la calle. Por ejemplo: “de la” en “Calle de la mesa” POST_ADDRESS: el valor puede contener frases que aparezcan después del nombre principal de la calle. Por ejemplo: “de la tiedra” en “Calle Ramón Pérez de la tiedra” PRE_DIRECTIONAL: el valor puede contener un dato direccional que aparezca antes del nombre principal de la calle. Por ejemplo: “South” en “123 South Main St” POST_DIRECTIONAL: el valor puede contener un dato direccional que aparezca después del nombre principal de la calle. Por ejemplo: “SW” en “123 River St SW” False No devolver los campos de calle individuales de forma independiente, devolver esto valores en el campo formattedStreetAddress. Opción predeterminada.
returnUnitInformation	Boolean	True Si está disponible, devuelve la información sobre el tipo y el valor de la unidad en forma independiente en los campos unitType y unitValue, al igual que en el campo formattedStreetAddress. False Si está disponible, devuelve la información sobre el tipo y el valor de la unidad solo en el campo formattedStreetAddress. Opción predeterminada.