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 las opciones disponibles.

URI base

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

Parámetros de la solicitud

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

: las direcciones que se van a geocodificar. El conjunto de direcciones de los objetos Dirección. La serie de direcciones puede incluir una o más direcciones de entrada. Obligatorio.
: el tipo de código geográfico. Opcional. El parámetro de tipo es opcional.
: las opciones de geocodificación y comparación. Opcional.
mustMatchMode: los criterios de cruce para determinar si los candidatos de cruce son opcionales.
returnFieldsDescriptor: controla la devolución de datos adicionales de un candidato. Opcional.

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


Parámetro	Tipo	Descripción
POST: type GET: 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.
POST: 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.
POST: fallbackToGeographic GET: 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.
POST: fallbackToPostal GET: 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.
POST: maxReturnedCandidates GET: maxCands	Integer	La cantidad máxima de candidatos que se deben devolver. Opcional. Debe ser un valor entero. Default = 1.
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).
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.
maxRanges	Integer	Un rango representa una serie de direcciones a lo largo de un segmento de calle. Por ejemplo, 5400-5499 Main St. es un rango de direcciones en la cuadra 5400 de Main St. Un rango puede representar solo direcciones impares o pares dentro de un segmento, o direcciones impares y pares. 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.
POST: 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`.
POST: 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.
POST: matchOnPostCode1	Boolean	true Se debe establecer un cruce con el campo PostCode1 de entrada. false No es necesario establecer un cruce con el campo de entrada . Opción predeterminada.
POST: matchOnPostCode2	Boolean	true Se debe establecer un cruce con el campo PostCode2 de entrada. false No es necesario establecer un cruce con el campo de entrada PostCode2. Opción predeterminada.
POST: matchOnAreaName1	Boolean	true Se debe establecer un cruce con el campo AreaName1 de entrada. false No es necesario establecer un cruce con el campo de entrada . Opción predeterminada.
POST: matchOnAreaName2	Boolean	true Se debe establecer un cruce con el campo AreaName2 de entrada. false No es necesario establecer un cruce con el campo de entrada . Opción predeterminada. Nota: Esta opción no es compatible en EE. UU.
POST: matchOnAreaName3	Boolean	true Se debe establecer un cruce con el campo AreaName3 de entrada. false No es necesario establecer un cruce con el campo de entrada . Opción predeterminada.
POST: matchOnAreaName4	Boolean	true Se debe establecer un cruce con el campo AreaName4 de entrada. false No es necesario establecer un cruce con el campo de entrada . Opción predeterminada.
POST: 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.
POST: 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.
POST: returnedCustomFieldKeys	List<String>	Especifica una lista de claves que representan los campos personalizados que se van a devolver en la salida del candidato. 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. Los campos personalizados varía según el país. Por ejemplo: “`CTYST_KEY`” o “`DATATYPE`”. Valor predeterminado: vacío
POST: 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.
POST: returnStreetAddressFields	Boolean	true Devuelve todos los campos de calle individuales que conforman el campo formattedStreetAddress de forma independiente, de la siguiente manera: MAIN_ADDRESS THOROUGHFARE_TYPE ADDRESS_ID PRE_ADDRESS — POST_ADDRESS PRE_DIRECTIONAL POST_DIRECTIONAL false No devolver los campos de calle individuales de forma independiente, devolver esto valores en el campo . Opción predeterminada.
POST: 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 y , al igual que en el campo . 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.