Search

Geocoding de direcciones

Se aplica a: planes de tarifa S0 y S1.

En muchos casos, el servicio de búsqueda completo puede ser demasiado, por ejemplo, si solo está interesado en la geocodización tradicional. También se puede acceder a la búsqueda para buscar direcciones exclusivamente. La geocodificación se realiza presionando el punto de conexión de geocodificación con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocoding se consultará para todo lo que esté por encima de los datos de nivel de calle. No se devolverá ningún POI. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También se ocupará de todo, desde direcciones o intersecciones de calles o intersecciones exactas, así como zonas geográficas de nivel superior, como centros de ciudades, condados, estados, etc.

Geocódigo inverso a una dirección

Se aplica a: planes de tarifa S0 y S1.

Puede haber ocasiones en las que necesite traducir una coordenada (por ejemplo: 37,786505, -122,3862) a una dirección postal comprensible para el usuario. A menudo, esto es necesario para realizar el seguimiento de las aplicaciones en las que recibe una fuente GPS del dispositivo o recurso y desea saber qué dirección se encuentra la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada.

Código geográfico inverso a una calle cruzada

Se aplica a: planes de tarifa S0 y S1.

Puede haber ocasiones en las que necesite traducir una coordenada (por ejemplo: 37,786505, -122,3862) en una calle transversal comprensible para el usuario. A menudo, esto es necesario para realizar el seguimiento de las aplicaciones en las que recibe una fuente GPS del dispositivo o recurso y desea saber qué dirección se encuentra la coordenada. Este punto de conexión devolverá información entre calles para una coordenada determinada.

Geocoding de direcciones estructuradas

Se aplica a: planes de tarifa S0 y S1.

También se puede acceder a la geocodización de direcciones de Azure para buscar direcciones estructuradas exclusivamente. El índice de búsqueda de geocoding se consultará para todo lo que esté por encima de los datos de nivel de calle. No se devolverá ningún POI. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo, desde direcciones o intersecciones exactas, así como zonas geográficas de nivel superior, como centros de ciudades, condados, estados, etc.

Búsqueda de formularios gratuitos

Se aplica a: planes de tarifa S0 y S1.

La API predeterminada básica es Free Form Search, que controla la más aproximada de las entradas que administran cualquier combinación de tokens de dirección o DE PUNTO de interés. Esta API de búsqueda es la "búsqueda de una sola línea" canónica. Free Form Search API es una combinación perfecta de búsqueda de puntos de interés y geocoding. La API también se puede ponderar con una posición contextual (par de latitud y pair), o totalmente restringido por una coordenada y un radio, o se puede ejecutar de forma más general sin ningún punto de anclaje de sesgo geográfico.

Le recomendamos encarecidamente que use el parámetro "countrySet" para especificar solo los países para los que la aplicación necesita cobertura, ya que el comportamiento predeterminado será buscar en todo el mundo, lo que podría devolver resultados innecesarios.

Por ejemplo: countrySet =US,FR

Consulte Cobertura de búsqueda para obtener una lista completa de todos los países admitidos.

La mayoría de las consultas de búsqueda tienen como valor maxFuzzyLevel predeterminado =2 para obtener un rendimiento y reducir también los resultados inusuales. Este nuevo valor predeterminado se puede invalidar según sea necesario por solicitud pasando el parámetro de consulta maxFuzzyLevel =3 o 4.

Búsqueda cercana

Se aplica a: planes de tarifa S0 y S1.

Si tiene un caso de uso para recuperar solo los resultados de poi alrededor de una ubicación específica, el método de búsqueda cercano puede ser la opción correcta. Este punto de conexión solo devolverá resultados de POI y no tendrá en cuenta ningún parámetro de consulta de búsqueda.

Obtener POI por nombre

Se aplica a: planes de tarifa S0 y S1.

La búsqueda de puntos de interés (POI) le permite solicitar resultados de POI por nombre. La búsqueda admite parámetros de consulta adicionales, como el idioma y el filtrado de resultados por área de interés controlada por país o cuadro de límite. El punto de conexión solo devolverá resultados de POI que coincidan con la cadena de consulta. La respuesta incluye detalles de puntos de interés, como la dirección, la ubicación de coordenadas y la categoría.

Obtener POI por categoría

Se aplica a: planes de tarifa S0 y S1.

La búsqueda de categorías de puntos de interés (POI) permite solicitar resultados de POI de una categoría determinada. La búsqueda permite consultar LOS POI de una categoría a la vez. El punto de conexión solo devolverá resultados de POI que se clasifican según lo especificado. La respuesta incluye detalles de puntos de interés, como la dirección, la ubicación de coordenadas y la clasificación.

Obtener árbol de categoría de POI

Se aplica a: planes de tarifa S0 y S1.

POI Category API proporciona una lista completa de categorías y subcategorías de puntos de interés (POI) compatibles junto con sus traducciones y sinónimos. El contenido devuelto se puede usar para proporcionar resultados más significativos a través de otras API de Search Service, como Obtener punto de interés de búsqueda.

Obtener polygon

Se aplica a: plan de tarifa S1.

El servicio Get Polygon permite solicitar los datos de geometría, como un esquema de ciudad o país para un conjunto de entidades, que se recuperaron previamente de una solicitud de búsqueda en línea en formato GeoJSON. El identificador de geometría se devuelve en el objeto dataSources en "geometry" e "id" en una llamada a Search Address o Search Fuzzy.

Tenga en cuenta que cualquier identificador de geometría recuperado de un punto de conexión de Búsqueda en línea tiene una duración limitada. El cliente no debe almacenar los identificadores de geometría en el almacenamiento persistente para referencias posteriores, ya que no se garantiza la estabilidad de estos identificadores durante un largo período de tiempo. Se espera que una solicitud al método Polygon se realiza unos minutos después de la solicitud al método de búsqueda en línea que proporcionó el identificador. El servicio permite solicitudes por lotes de hasta 20 identificadores.

API de Batch de direcciones de búsqueda

Se aplica a: plan de tarifa S1.

Search Address Batch API envía lotes de consultas a Search Address API mediante una sola llamada API. Puede llamar a Search Address Batch API para ejecutarse de forma asincrónica (asincrónica) o sincrónica (sincronización). La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100.

Enviar solicitud por lotes sincrónica

La API sincrónica se recomienda para las solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá en cuanto se calcule el lote de elementos y no habrá ninguna posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes está limitado a 100 para esta API.

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud asincrónica por lotes

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de búsqueda relativamente complejas.

• Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
• La API asincrónica está optimizada para la confiabilidad y no se espera que se agote el tiempo de espera.
• El número de elementos por lotes está limitado a 10 000 para esta API.

Cuando realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL se debe comprobar periódicamente hasta que estén disponibles los datos de respuesta o la información de error. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una solicitud de ejecución larga. Esta es una secuencia típica de operaciones:

1. El cliente envía una solicitud de lote de POST direcciones de búsqueda a Azure Mapas

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se ha aceptado la solicitud por lotes.

   HTTP: Error se ha producido un error al procesar la solicitud de Batch. Podría ser o cualquier 400 Bad Request otro Error código de estado.

3. Si la solicitud por lotes se aceptó correctamente, el encabezado de la respuesta contiene la Location dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado tiene el siguiente aspecto:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

4. El cliente emite una GET solicitud en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados del lote.

Cuerpo DE POST para la solicitud por lotes

Para enviar las consultas de dirección de búsqueda, usará una solicitud en la que el cuerpo de la solicitud contendrá la matriz en formato y el encabezado se POST batchItems json Content-Type establecerá en application/json . Este es un cuerpo de solicitud de ejemplo que contiene 5 consultas de direcciones de búsqueda:

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Una consulta de dirección de búsqueda en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de los parámetros de URI de dirección de búsqueda admitidos. Los valores de cadena de la consulta de dirección de búsqueda deben tener una secuencia de escape correcta (por ejemplo, " el carácter debe ser de escape con ) y también debe estar correctamente codificado \ en url.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100, y el lote debe contener al menos una consulta.

Descarga de resultados asincrónicos por lotes

Para descargar los resultados del lote asincrónico, emitirá una GET solicitud al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado de una solicitud por Location POST lotes correcta y tiene un aspecto similar al siguiente:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

1. El cliente envía una GET solicitud mediante la dirección URL de descarga.

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

   HTTP: 200 OK solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud de lote asincrónico, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta del lote. Esta respuesta por lotes contiene un componente que indica que formaban parte de la solicitud por lotes original y, por ejemplo, las consultas que se summary totalRequests successfulRequests ejecutaron correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta de la solicitud por lotes. contendrá los resultados exactamente en el mismo orden en que se enviaron las consultas originales batchItems en la solicitud por lotes. Cada elemento de batchItems contiene los campos y statusCode response . Cada response de es de uno de los siguientes batchItems tipos:

• SearchAddressResponse - Si la consulta se completó correctamente.

• Error - Si la consulta no se pudo realizar. En este caso, la code respuesta contendrá y message .

Este es un ejemplo de respuesta por lotes con 2 resultados correctos y 1 con error:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

Search Address Reverse Batch API

Se aplica a: plan de tarifa S1.

Search Address Batch API envía lotes de consultas a Search Address Reverse API mediante una sola llamada API. Puede llamar a Search Address Reverse Batch API para ejecutarse de forma asincrónica (asincrónica) o sincrónica (sincronización). La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100.

Enviar solicitud por lotes sincrónica

La API sincrónica se recomienda para las solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá en cuanto se calcule el lote de elementos y no habrá ninguna posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes está limitado a 100 para esta API.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud asincrónica por lotes

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de búsqueda relativamente complejas.

• Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
• La API asincrónica está optimizada para la confiabilidad y no se espera que se agote el tiempo de espera.
• El número de elementos por lotes está limitado a 10 000 para esta API.

Cuando realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL se debe comprobar periódicamente hasta que estén disponibles los datos de respuesta o la información de error. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una solicitud de ejecución larga. Esta es una secuencia típica de operaciones:

1. El cliente envía una solicitud de lote de POST direcciones de búsqueda a Azure Mapas

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se ha aceptado la solicitud por lotes.

   HTTP: Error se ha producido un error al procesar la solicitud de Batch. Podría ser o cualquier 400 Bad Request otro Error código de estado.

3. Si la solicitud por lotes se aceptó correctamente, el encabezado de la respuesta contiene la Location dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado tiene el siguiente aspecto:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

4. El cliente emite una GET solicitud en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados del lote.

Cuerpo DE POST para la solicitud por lotes

Para enviar las consultas inversas de la dirección de búsqueda, usará una solicitud en la que el cuerpo de la solicitud contendrá la matriz en formato y el encabezado POST se batchItems json Content-Type establecerá en application/json . Este es un cuerpo de solicitud de ejemplo que contiene 5 consultas inversas de direcciones de búsqueda:

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Una consulta inversa de dirección de búsqueda en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de los parámetros de URI inverso de dirección de búsqueda admitidos. Los valores de cadena de la consulta inversa de la dirección de búsqueda deben tener una secuencia de escape correcta (por ejemplo, " el carácter debe ser de escape con ) y también debe estar correctamente codificado en \ url.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100, y el lote debe contener al menos una consulta.

Descarga de resultados asincrónicos por lotes

Para descargar los resultados del lote asincrónico, emitirá una GET solicitud al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado de una solicitud por Location POST lotes correcta y tiene un aspecto similar al siguiente:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

1. El cliente envía una GET solicitud mediante la dirección URL de descarga.

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

   HTTP: 200 OK solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud de lote asincrónico, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta del lote. Esta respuesta por lotes contiene un componente que indica que formaban parte de la solicitud por lotes original y, por ejemplo, las consultas que se summary totalRequests successfulRequests ejecutaron correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta de la solicitud por lotes. contendrá los resultados exactamente en el mismo orden en que se enviaron las consultas originales batchItems en la solicitud por lotes. Cada elemento de batchItems contiene los campos y statusCode response . Cada response de es de uno de los siguientes batchItems tipos:

• SearchAddressReverseResponse - Si la consulta se completó correctamente.

• Error - Si la consulta no se pudo realizar. En este caso, la code respuesta contendrá y message .

Este es un ejemplo de respuesta por lotes con 2 resultados correctos y 1 con error:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

Se aplica a: planes de tarifa S0 y S1.

El punto de conexión De búsqueda a lo largo de la ruta permite realizar una búsqueda aproximada de PUNTOS DE COMPRA a lo largo de una ruta especificada. Esta búsqueda se restringe especificando la maxDetourTime medida de limitación.

Para enviar los puntos de ruta, usará una solicitud donde el cuerpo de la solicitud contendrá el objeto representado como un tipo y el encabezado POST route se GeoJSON LineString Content-Type establecerá en application/json . Cada punto de ruta de se representa como un tipo, es decir, una matriz donde el valor de longitud va seguido del valor de latitud y el valor de altitud route GeoJSON Position se omite. debe route contener al menos 2 puntos de ruta.

Es posible que se altere la ruta original; algunos de sus puntos se pueden omitir. Si la ruta que pasa a través del punto encontrado es más rápida que la original, el detourTime valor de la respuesta es negativo.

Search Fuzzy Batch API

Se aplica a: plan de tarifa S1.

Search Address Batch API envía lotes de consultas a Search Fuzzy API mediante una sola llamada API. Puede llamar a search address Fuzzy Batch API para ejecutarse de forma asincrónica (asincrónica) o sincrónica (sincronización). La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100.

Enviar solicitud por lotes sincrónica

La API sincrónica se recomienda para las solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá en cuanto se calcule el lote de elementos y no habrá ninguna posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes está limitado a 100 para esta API.

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Envío de una solicitud asincrónica por lotes

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de búsqueda relativamente complejas.

• Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
• La API asincrónica está optimizada para la confiabilidad y no se espera que se agote el tiempo de espera.
• El número de elementos por lotes se limita a 10 000 para esta API.

Cuando realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL se debe comprobar periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una solicitud de larga duración. Esta es una secuencia típica de operaciones:

1. El cliente envía una solicitud de Lote de direcciones POST de búsqueda a Azure Mapas

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se ha aceptado la solicitud por lotes.

   HTTP: Error se produjo un error al procesar la solicitud de Batch. Podría ser o cualquier 400 Bad Request otro Error código de estado.

3. Si la solicitud por lotes se aceptó correctamente, el encabezado de la respuesta contiene la Location dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado tiene el siguiente aspecto:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

4. El cliente emite una GET solicitud en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados del lote.

Cuerpo de POST para la solicitud por lotes

Para enviar las consultas aproximadas de búsqueda, usará una solicitud en la que el cuerpo de la solicitud contendrá la matriz en formato y el encabezado se POST batchItems json Content-Type establecerá en application/json . Este es un cuerpo de solicitud de ejemplo que contiene 5 consultas aproximadas de búsqueda:

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Una consulta aproximada de búsqueda en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de los parámetros uri de búsqueda aproximada admitidos. Los valores de cadena de la consulta aproximada de búsqueda deben tener caracteres de escape correctos (por ejemplo, " el carácter debe tener caracteres de escape con ) y también debe codificarse correctamente en \ dirección URL.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100, y el lote debe contener al menos 1 consulta.

Descarga de resultados por lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una GET solicitud al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado de una solicitud por Location POST lotes correcta y tiene el siguiente aspecto:

https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

1. El cliente envía una GET solicitud mediante la dirección URL de descarga.

2. El servidor responderá con uno de los siguientes elementos:

   HTTP: 202 Accepted se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

   HTTP: 200 OK solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente que indica que formaban parte de la solicitud por lotes original y, por ejemplo, las consultas que se ejecutaron summary totalRequests successfulRequests correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta de la solicitud por lotes. contendrá los resultados exactamente en el mismo orden en que se enviaron las consultas originales batchItems en la solicitud por lotes. Cada elemento de batchItems contiene los campos y statusCode response . Cada response en es de uno de los siguientes batchItems tipos:

• SearchFuzzyResponse - Si la consulta se completó correctamente.

• Error - Si la consulta no se pudo realizar. La respuesta contendrá un code y un en este message caso.

Este es un ejemplo de respuesta por lotes con 2 resultados correctos y 1 con error:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

Se aplica a: planes de tarifa S0 y S1.

El punto de conexión Buscar geometría permite realizar una búsqueda de forma libre dentro de una sola geometría o de muchas de ellas. Se devolverán los resultados de búsqueda que se encuentran dentro de las geometrías o geometrías.

Para enviar la geometría, usará una solicitud en la que el cuerpo de la solicitud contendrá el objeto representado como un tipo y el encabezado se POST geometry GeoJSON Content-Type establecerá en application/json . Las características geográficas que se buscarán se pueden modelar como geometrías de polígono o círculo representadas mediante cualquiera de los siguientes GeoJSON tipos:

• GeoJSON FeatureCollection
  se geometry puede representar como un objeto GeoJSON FeatureCollection . Esta es la opción recomendada si la geometría contiene polígonos y círculos. puede FeatureCollection contener un máximo de 50 GeoJSON Feature objetos. Cada Feature objeto debe representar un polígono o un círculo con las condiciones siguientes:
  • Un objeto para la geometría Polygon puede tener un máximo de 50 coordenadas y Feature sus propiedades deben estar vacías.
  • Un objeto para la geometría de círculo se compone de un centro representado mediante un tipo y un valor de radio (en metros) que se deben especificar en las propiedades del objeto junto con la propiedad subType cuyo valor debe ser Feature GeoJSON Point 'Circle'.
  
  Consulte la sección Ejemplos a continuación para obtener una representación de FeatureCollection ejemplo.
  
  
• GeoJSON GeometryCollection
  se geometry puede representar como un objeto GeoJSON GeometryCollection . Esta es la opción recomendada si la geometría solo contiene una lista de polígonos. puede GeometryCollection contener un máximo de 50 GeoJSON Polygon objetos. Cada Polygon objeto puede tener un máximo de 50 coordenadas. Consulte la sección Ejemplos a continuación para obtener una representación de GeometryCollection ejemplo.
  
  
• Polígono GeoJSON
  se geometry puede representar como un objeto GeoJSON Polygon . Esta es la opción recomendada si la geometría contiene un único polygon. El Polygon objeto puede tener un máximo de 50 coordenadas. Consulte la sección Ejemplos a continuación para obtener una representación de Polygon ejemplo.