Search

Service:
Maps
API Version:
1.0

Operations

Get Search Address

Геокодирование адреса

Применимо к : ценовые категории S0 и S1.

Во многих случаях полная служба поиска может быть слишком большой, например, если вас интересует только традиционную геокодирование. Поиск можно также получить только для поиска по адресу. Геокодирование выполняется путем обращения к конечной точке геокода с использованием только адреса или частичного адреса. Индекс поиска геокодирования будет запрашиваться для всех выше данных уровня улицы. Интереса не будет возвращено. Обратите внимание, что геокодированию достаточно чувствительно к опечаткам и неполным адресам. Он также будет выполнять все действия, начиная с точных адресов улицы или улицы, а также с географическими географией, такими как центры городов, районы, Штаты и т. д.
Get Search Address Reverse

Обратный геокод к адресу

Применимо к : ценовые категории S0 и S1.

Иногда приходится преобразовывать координаты (например: 37,786505,-122,3862) в адрес улицы, понятный человеку. Чаще всего это необходимо для отслеживания приложений, в которых вы получаете канал GPS с устройства или ресурса и хотите узнать, в каком адресе находится координата. Эта конечная точка будет возвращать сведения об адресе для заданной координаты.
Get Search Address Reverse Cross Street

Обратная геопрограмма к перекрестной улицы

Применимо к : ценовые категории S0 и S1.

Иногда приходится преобразовывать координаты (например: 37,786505,-122,3862) в удобное для человека перекрестное улица. Чаще всего это необходимо для отслеживания приложений, в которых вы получаете канал GPS с устройства или ресурса и хотите узнать, в каком адресе находится координата. Эта конечная точка будет возвращать сведения о перекрестной улицы для заданной координаты.
Get Search Address Structured

Геокодирование структурированного адреса

Применимо к : ценовые категории S0 и S1.

Доступ к геокодированию адресов Azure можно также получить только для поиска в структурированном адресе. Индекс поиска геокодирования будет запрашиваться для всех выше данных уровня улицы. Интереса не будет возвращено. Обратите внимание, что геокодированию достаточно чувствительно к опечаткам и неполным адресам. Он также будет выполнять все действия, начиная с точных адресов улицы или улицы, а также с географическими географией, такими как центры городов, районы, Штаты и т. д.
Get Search Fuzzy

Поиск в свободной форме

Применимо к : ценовые категории S0 и S1.

Основной API по умолчанию является бесплатным поиском по форме, который обрабатывает наиболее нечеткие входные данные, обрабатывая любую комбинацию адресов или маркеров достопримечательности. Этот API поиска является каноническим "однострочный Поиск". API бесплатной поиска формы — это простое сочетание поиска достопримечательности и геокодирования. Этому API также можно назначить взвешенное значение с помощью контекстно-зависимой позиции (пары широты или долготы), ) или полностью ограничены координатами и радиусом, либо могут выполняться более широко без точки привязки геосмещения.

Мы настоятельно рекомендуем использовать параметр "Country" («страна»), чтобы указать только страны, для которых приложение нуждается в покрытии, так как поведение по умолчанию будет искать весь мир, потенциально возвращая ненужные результаты.

Например: countrySet = US, fr

Полный список поддерживаемых стран см. в разделе " охват поиска ".

Большинство поисковых запросов по умолчанию равно maxFuzzyLevel 2 для повышения производительности, а также уменьшения необычных результатов. Это новое значение по умолчанию можно переопределить по мере необходимости для запроса, передав параметр запроса maxFuzzyLevel = 3 или 4.
Get Search Nearby

Поиск поблизости

Применимо к : ценовые категории S0 и S1.

Если у вас есть вариант использования только для получения результатов достопримечательности в определенном расположении, то ближайший метод поиска может быть верным выбором. Эта конечная точка будет возвращать только результаты достопримечательности и не принимает параметр поискового запроса.
Get Search POI

Получить достопримечательности по имени

Применимо к : ценовые категории S0 и S1.

Поиск интересующих элементов (достопримечательности) позволяет запрашивать результаты достопримечательности по имени. Поиск поддерживает дополнительные параметры запроса, такие как язык и результаты фильтрации по области интересов, которые определяются по стране или ограничивающему прямоугольнику. Конечная точка будет возвращать только результаты достопримечательности, соответствующие строке запроса. Ответ включает в себя достопримечательности такие сведения, как адрес, координата координаты и Категория.
Get Search POI Category

Получить достопримечательности по категории

Применимо к : ценовые категории S0 и S1.

Поиск по категории интересов (достопримечательности) позволяет запросить результаты достопримечательности из данной категории. Поиск позволяет запрашивать интереса из одной категории за раз. Конечная точка будет возвращать только результаты достопримечательности, которые классифицируются по указанным категориям. Ответ включает в себя достопримечательности такие сведения, как адрес, координата координаты и классификация.
Get Search POI Category Tree Preview

Получить дерево категорий достопримечательности

Применимо к : ценовые категории S0 и S1.

API категории Достопримечательности содержит полный список поддерживаемых категорий и подкатегорий (достопримечательности), а также их переводы и синонимы. Возвращаемое содержимое можно использовать для предоставления более значимых результатов через другие Служба поиска API, например Get Search достопримечательности.
Get Search Polygon

Получить многоугольник

Область применения : ценовая категория S1.

Служба "получение многоугольников" позволяет запрашивать геометрические данные, такие как город или страна для набора сущностей, ранее извлеченных из запроса поиска в Интернете в формате геоjson. Идентификатор геометрии возвращается в объекте DataSources в разделе "Geometry" и "ID" в адресе поиска или в вызове нечетких результатов поиска.

Обратите внимание, что любой идентификатор геометрии, полученный из конечной точки поиска в сети, имеет ограниченное время существования. Клиент не должен хранить идентификаторы геометрии в постоянном хранилище для последующей ссылки, так как стабильность этих идентификаторов не гарантируется в течение длительного периода времени. Ожидается, что запрос к методу Polygon выполняется в течение нескольких минут запроса к методу поиска в сети, который предоставил идентификатор. Служба позволяет пакетным запросам не более 20 идентификаторов.
Post Search Address Batch

API пакета поиска адреса

Область применения : ценовая категория S1.

API пакетного поиска адреса отправляет пакеты запросов в API адреса поиска , используя только один вызов API. API пакетного поиска можно вызвать для асинхронного выполнения (асинхронного) или синхронного (Sync). Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов.

Отправка синхронного пакетного запроса

Для упрощенных пакетных запросов рекомендуется использовать синхронный API. Когда служба получает запрос, она будет отвечать сразу после вычисления элементов пакетной службы и не сможет получить результаты позже. Синхронный API возвратит ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Число элементов пакета ограничено 100 для этого API.

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

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных запросов поиска.

  • Это позволяет получить результаты в отдельном вызове (возможно несколько Скачиваний).
  • Асинхронный API оптимизирован для обеспечения надежности и не должен выполняться в течение времени ожидания.
  • Число элементов пакета ограничено 10 000 для этого API.

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 и URL-адрес перенаправления в поле Location заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если он использовался после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос является долго выполняющимся запросом. Ниже приведена типичная последовательность операций.

  1. Клиент отправляет пакетный запрос поиска адреса POST в Azure Maps

  2. Сервер будет отвечать одним из следующих элементов:

    202 AcceptedЗапрос HTTP-Batch принят.

    HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть либо 400 Bad Request любой другой Error код состояния.

  3. Если пакетный запрос был успешно принят, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот URI состояния выглядит следующим образом:

    GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Клиент выдает GET запрос на URL-адрес скачивания , полученный на шаге 3, для скачивания результатов пакета.

Тело сообщения POST для пакетного запроса

Для отправки запросов поиска по адресу будет использоваться POST запрос, в котором текст запроса будет содержать batchItems массив в json формате, а Content-Type для заголовка будет задано значение application/json . Ниже приведен пример текста запроса, содержащего 5 запросов поиска адреса :

{
    "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"}
    ]
}

Запрос адреса поиска в пакете — это просто частичный URL-адрес без протокола, базовый URL-адрес, путь, API-версия и ключ подписки. Он может принимать любой из поддерживаемых параметров URI адреса поиска . Строковые значения в запросе поиска адреса должны быть правильно экранированы (например, символ должен быть экранирован с помощью символа \ ), а также должны быть правильно закодированы в URL-адресе.

Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов, а пакет должен содержать по крайней мере 1 запрос.

Скачать асинхронные результаты пакетной службы

Для загрузки асинхронных результатов пакетной службы будет выдан GET запрос на конечную точку скачивания пакета. Этот URL-адрес загрузки можно получить из Location заголовка успешного POST пакетного запроса и выглядит следующим образом:

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

Ниже приведена типичная последовательность операций по скачиванию результатов пакета.

  1. Клиент отправляет GET запрос, используя URL-адрес скачивания.

  2. Сервер будет отвечать одним из следующих элементов:

    HTTP 202 Accepted -пакетный запрос принят, но еще обрабатывается. Повторите попытку через некоторое время.

    HTTP 200 OK -пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Содержимое возвращаемых данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит summary компонент, который указывает totalRequests , что был частью исходного запроса пакета и successfulRequests т. е. запросов, которые были выполнены успешно. Пакетный ответ также содержит batchItems массив, который содержит ответ для каждого запроса в пакетном запросе. Объект batchItems будет содержать результаты в точно таком же порядке, в котором были отправлены исходные запросы в пакетном запросе. Каждый элемент в batchItems statusCode полях Contains и response . Каждый response в batchItems имеет один из следующих типов:

  • SearchAddressResponse — Если запрос успешно выполнен.

  • Error — Если запрос завершился ошибкой. codeВ этом случае ответ будет содержать и message .

Ниже приведен пример ответа пакетной службы с 2 успешным и 1 неудачным результатом:

{
    "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."
                }
            }
        }
    ]
}
Post Search Address Reverse Batch

Поиск адреса API обратных пакетов

Область применения : ценовая категория S1.

API пакетного поиска адреса отправляет пакеты запросов для поиска в обратный API адреса , используя только один вызов API. Вы можете вызвать обратный пакет API для функции поиска адреса, чтобы асинхронно (асинхронно) или синхронно (Sync). Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов.

Отправка синхронного пакетного запроса

Для упрощенных пакетных запросов рекомендуется использовать синхронный API. Когда служба получает запрос, она будет отвечать сразу после вычисления элементов пакетной службы и не сможет получить результаты позже. Синхронный API возвратит ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Число элементов пакета ограничено 100 для этого API.

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

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных запросов поиска.

  • Это позволяет получить результаты в отдельном вызове (возможно несколько Скачиваний).
  • Асинхронный API оптимизирован для обеспечения надежности и не должен выполняться в течение времени ожидания.
  • Число элементов пакета ограничено 10 000 для этого API.

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 и URL-адрес перенаправления в поле Location заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если он использовался после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос является долго выполняющимся запросом. Ниже приведена типичная последовательность операций.

  1. Клиент отправляет пакетный запрос поиска адреса POST в Azure Maps

  2. Сервер будет отвечать одним из следующих элементов:

    202 AcceptedЗапрос HTTP-Batch принят.

    HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть либо 400 Bad Request любой другой Error код состояния.

  3. Если пакетный запрос был успешно принят, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот URI состояния выглядит следующим образом:

    GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Клиент выдает GET запрос на URL-адрес скачивания , полученный на шаге 3, для скачивания результатов пакета.

Тело сообщения POST для пакетного запроса

Для отправки запросов поиска в обратных запросах будет использоваться POST запрос, в котором текст запроса будет содержать batchItems массив в json формате, а Content-Type для заголовка будет задано значение application/json . Ниже приведен пример текста запроса, содержащего 5 запросов поиска в обратных адресах :

{
    "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"}
    ]
}

Обратный запрос адреса поиска в пакете — это просто частичный URL-адрес без протокола, базовый URL-адрес, путь, API-версия и ключ подписки. Он может принимать любой из поддерживаемых параметров обратных URI адреса поиска URI parameters. Строковые значения в обратных запросах поиска адреса должны быть правильно экранированы (например, символ должен быть экранирован с помощью символа \ ), а также должны быть правильно закодированы в URL-адресе.

Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов, а пакет должен содержать по крайней мере 1 запрос.

Скачать асинхронные результаты пакетной службы

Для загрузки асинхронных результатов пакетной службы будет выдан GET запрос на конечную точку скачивания пакета. Этот URL-адрес загрузки можно получить из Location заголовка успешного POST пакетного запроса и выглядит следующим образом:

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

Ниже приведена типичная последовательность операций по скачиванию результатов пакета.

  1. Клиент отправляет GET запрос, используя URL-адрес скачивания.

  2. Сервер будет отвечать одним из следующих элементов:

    HTTP 202 Accepted -пакетный запрос принят, но еще обрабатывается. Повторите попытку через некоторое время.

    HTTP 200 OK -пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Содержимое возвращаемых данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит summary компонент, который указывает totalRequests , что был частью исходного запроса пакета и successfulRequests т. е. запросов, которые были выполнены успешно. Пакетный ответ также содержит batchItems массив, который содержит ответ для каждого запроса в пакетном запросе. Объект batchItems будет содержать результаты в точно таком же порядке, в котором были отправлены исходные запросы в пакетном запросе. Каждый элемент в batchItems statusCode полях Contains и response . Каждый response в batchItems имеет один из следующих типов:

  • SearchAddressReverseResponse — Если запрос успешно выполнен.

  • Error — Если запрос завершился ошибкой. codeВ этом случае ответ будет содержать и message .

Ниже приведен пример ответа пакетной службы с 2 успешным и 1 неудачным результатом:

{
    "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."
                }
            }
        }
    ]
}
Post Search Along Route

Применимо к : ценовые категории S0 и S1.

Поиск по конечной точке маршрута позволяет выполнять нечеткий поиск интереса вдоль указанного маршрута. Этот поиск ограничивается путем указания maxDetourTime меры ограничения.

Чтобы отправить точки маршрута, будет использоваться запрос, в POST котором текст запроса будет содержать route объект, представленный в виде GeoJSON LineString типа, а Content-Type для заголовка будет задано значение application/json . Каждая точка маршрута в route представлена как GeoJSON Position тип, т. е. массив, где за значением долготы следует значение широты , а значение высоты не учитывается. routeДолжен содержать по крайней мере 2 точки маршрута.

Возможно, исходный маршрут будет изменен, некоторые из его точек могут быть пропущены. Если маршрут, проходящий через найденную точку, работает быстрее, чем исходная, то detourTime значение в ответе будет отрицательным.
Post Search Fuzzy Batch

API нечеткого пакета поиска

Область применения : ценовая категория S1.

API пакетного поиска адреса отправляет пакеты запросов в API нечеткого поиска , используя только один вызов API. Можно вызвать интерфейс API нечеткого пакета поиска адреса для асинхронного или синхронного запуска (синхронизации). Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов.

Отправка синхронного пакетного запроса

Для упрощенных пакетных запросов рекомендуется использовать синхронный API. Когда служба получает запрос, она будет отвечать сразу после вычисления элементов пакетной службы и не сможет получить результаты позже. Синхронный API возвратит ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Число элементов пакета ограничено 100 для этого API.

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

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных запросов поиска.

  • Это позволяет получить результаты в отдельном вызове (возможно несколько Скачиваний).
  • Асинхронный API оптимизирован для обеспечения надежности и не должен выполняться в течение времени ожидания.
  • Число элементов пакета ограничено 10 000 для этого API.

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 и URL-адрес перенаправления в поле Location заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если он использовался после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос является долго выполняющимся запросом. Ниже приведена типичная последовательность операций.

  1. Клиент отправляет пакетный запрос поиска адреса POST в Azure Maps

  2. Сервер будет отвечать одним из следующих элементов:

    202 AcceptedЗапрос HTTP-Batch принят.

    HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть либо 400 Bad Request любой другой Error код состояния.

  3. Если пакетный запрос был успешно принят, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот URI состояния выглядит следующим образом:

    GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Клиент выдает GET запрос на URL-адрес скачивания , полученный на шаге 3, для скачивания результатов пакета.

Тело сообщения POST для пакетного запроса

Чтобы отправить запрос поиска нечетких запросов, будет использоваться POST запрос, в котором текст запроса будет содержать batchItems массив в json формате, а Content-Type для заголовка будет задано значение application/json . Ниже приведен пример текста запроса, содержащего 5 нечетких запросов поиска :

{
    "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"}
    ]
}

Нечеткий запрос поиска в пакете — это просто частичный URL-адрес без протокола, базовый URL-адрес, путь, API-версия и ключ подписки. Он может принимать любые поддерживаемые параметры поиска нечеткого URI. Строковые значения в запросе нечеткого поиска должны быть правильно экранированы (например, символ должен быть экранирован с помощью символа \ ), а также должны быть правильно закодированы в URL-адресе.

Асинхронный API позволяет вызывающей стороне выполнять пакетную обработку до 10 000 запросов и API синхронизации до 100 запросов, а пакет должен содержать по крайней мере 1 запрос.

Скачать асинхронные результаты пакетной службы

Для загрузки асинхронных результатов пакетной службы будет выдан GET запрос на конечную точку скачивания пакета. Этот URL-адрес загрузки можно получить из Location заголовка успешного POST пакетного запроса и выглядит следующим образом:

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

Ниже приведена типичная последовательность операций по скачиванию результатов пакета.

  1. Клиент отправляет GET запрос, используя URL-адрес скачивания.

  2. Сервер будет отвечать одним из следующих элементов:

    HTTP 202 Accepted -пакетный запрос принят, но еще обрабатывается. Повторите попытку через некоторое время.

    HTTP 200 OK -пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Содержимое возвращаемых данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит summary компонент, который указывает totalRequests , что был частью исходного запроса пакета и successfulRequests т. е. запросов, которые были выполнены успешно. Пакетный ответ также содержит batchItems массив, который содержит ответ для каждого запроса в пакетном запросе. Объект batchItems будет содержать результаты в точно таком же порядке, в котором были отправлены исходные запросы в пакетном запросе. Каждый элемент в batchItems statusCode полях Contains и response . Каждый response в batchItems имеет один из следующих типов:

  • SearchFuzzyResponse — Если запрос успешно выполнен.

  • Error — Если запрос завершился ошибкой. codeВ этом случае ответ будет содержать и message .

Ниже приведен пример ответа пакетной службы с 2 успешным и 1 неудачным результатом:

{
    "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."
                }
            }
        }
    ]
}
Post Search Inside Geometry

Применимо к : ценовые категории S0 и S1.

Конечная точка геометрического поиска позволяет выполнять поиск в свободной форме внутри одной или нескольких объектов. Будут возвращены результаты поиска, попадающие в геометрию или геометрические объекты.

Чтобы отправить геометрию, будет использоваться запрос, в POST котором текст запроса будет содержать объект, geometry представленный в виде GeoJSON типа, а Content-Type для заголовка будет задано значение application/json . Географические функции для поиска можно моделировать как многоугольники и (или) круги, представленные с помощью одного из следующих GeoJSON типов:

  • Феатуреколлектион геоjson
    geometryМожет быть представлен как GeoJSON FeatureCollection объект. Это рекомендуемый вариант, если геометрия содержит как многоугольники, так и круги. FeatureCollectionМожет содержать не более 50 GeoJSON Feature объектов. Каждый Feature объект должен представлять либо многоугольник, либо круг со следующими условиями:
    • FeatureОбъект для геометрии многоугольника может иметь не более 50 координат, а свойства должны быть пустыми.
    • FeatureОбъект для круговой геометрии состоит из центра , представленного с помощью GeoJSON Point типа, и значения радиуса (в метрах), которое должно быть указано в свойствах объекта вместе со свойством подтипа , значение которого должно быть "Circle".

    Пример представления см. в разделе "примеры" ниже FeatureCollection .

  • GeometryCollection геоjson
    geometryМожет быть представлен как GeoJSON GeometryCollection объект. Это рекомендуемый вариант, если геометрия содержит только список многоугольников. GeometryCollectionМожет содержать не более 50 GeoJSON Polygon объектов. Каждый Polygon объект может иметь максимум 50 координат. Пример представления см. в разделе "примеры" ниже GeometryCollection .

  • Многоугольник геоjson
    geometryМожет быть представлен как GeoJSON Polygon объект. Это рекомендуемый вариант, если геометрия содержит один многоугольник. PolygonОбъект может иметь максимум 50 координат. Пример представления см. в разделе "примеры" ниже Polygon .

.