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:

.[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:

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.

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

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.
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 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.
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. Address Código geográfico para una dirección de calle. Opción predeterminada. Geographic Código geográfico para el centroide geográfico de una ciudad o un estado. Postal Código geográfico para un código postal.
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. True Devuelve toda la información disponible para cada candidato. False No devolver toda la información disponible para cada candidato. Opción predeterminada.
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. 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.
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. 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.
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. True Use el World Geocoder (XWG) para asociar cuando el geocodificador de un país no esté instalado o si se instaló sin un conjunto de datos de geocodificación. False No use el World Geocoder (XWG) para asociar cuando el geocodificador de un país no esté instalado o si se instaló sin un conjunto de datos de geocodificación Opción predeterminada.
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: 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
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.
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`.
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, mustMatchFields 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 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í: `<customPreferences> <entry> <key>USA.maxReturnedCandidates</key> <value>3</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.
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	True Se debe establecer un cruce con el número de dirección de entrada. False No es necesario establecer un cruce con el número de dirección de entrada. Opción predeterminada.
matchOnPostCode1	Boolean	True Se debe establecer un cruce con el campo de entrada PostCode1. False No es necesario establecer un cruce con el campo de entrada PostCode1. Opción predeterminada.
matchOnAreaName1	Boolean	True Se debe establecer un cruce con el campo de entrada AreaName1. False No es necesario establecer un cruce con el campo de entrada AreaName1. Opción predeterminada.
matchOnAreaName2	Boolean	True Se debe establecer un cruce con el campo de entrada AreaName2. False No es necesario establecer un cruce con el campo de entrada AreaName2. Opción predeterminada. Nota: Esta opción no es compatible en EE. UU.
matchOnAreaName3	Boolean	True Se debe establecer un cruce con el campo de entrada AreaName3. False No es necesario establecer un cruce con el campo de entrada AreaName3. Opción predeterminada.
matchOnAreaName4	Boolean	True Se debe establecer un cruce con el campo de entrada AreaName4. False No es necesario establecer un cruce con el campo de entrada AreaName4. Opción predeterminada.
matchOnAllStreetFields	Boolean	True Se debe establecer un cruce con el nombre de calle de entrada, el tipo y los campos de dirección. False No es necesario establecer un cruce con el nombre de calle de entrada, el tipo y los campos de dirección. Opción predeterminada.
mustMatchInput	Boolean	True Se ignoran los otros campos de coincidencia obligatoria y cualquiera de los campos de entrada posibles provistos (código postal, nombres de área, etc.) deben coincidir con el candidato para que este vuelva. False Se deben respetar los otros campos de coincidencia obligatoria. No es necesario hacer una coincidencia con ningún campo de entrada específico provisto para que se devuelva el candidato. Opción predeterminada.
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.