Search - Get Search Address Reverse Batch

Ссылка

Service:: Maps

API Version:: 1.0

Используйте для отправки пакета запросов в API обратного адреса Поиск в одном асинхронном запросе.

API Get Search Address Reverse Batch — это HTTP-запросGET, который отправляет пакеты запросов Поиск API обратного адреса в одном асинхронном вызове API. Вы можете вызвать Get Search Address Reverse Batch 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 оптимизирован для обеспечения надежности и не ожидается, что время ожидания истекло.
Количество пакетных элементов для этого API ограничено 10 000 .

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

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

Клиент отправляет запрос обратной пакетной службы POST Поиск address в Azure Maps.

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

Сервер ответит одним из следующих ответов:

HTTP 202 Accepted — пакетный запрос принят.

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

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

Клиент отправляет 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 адреса поиска. Строковые значения в обратном запросе адреса поиска должны быть правильно экранированы (например, символ должен быть экранирован с \ ), а также правильно закодирован URL-адрес.

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

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

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

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

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

Клиент отправляет запрос, GET используя URL-адрес для скачивания.
Сервер ответит одним из следующих ответов:

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

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

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

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. Если при скачивании результатов асинхронного пакетного запроса обработка пакета завершена, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит компонент , указывающий summarytotalRequests , который был частью исходного пакетного запроса, и successfulRequestsт. е. запросы, которые были успешно выполнены. Пакетный ответ также содержит batchItems массив, содержащий ответ для каждого запроса в пакетном запросе. Будет batchItems содержать результаты в том же порядке, в котором исходные запросы были отправлены в пакетном запросе. Каждый элемент в batchItems содержит statusCode поля и 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."
                }
            }
        }
    ]
}

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	string	Идентификатор пакетной службы для запроса операции.
api-version	query	True	string	Номер версии API Azure Maps

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	ReverseSearchAddressBatchProcessResult	ОК
202 Accepted		Поддерживается только для асинхронного запроса. Запрос принят: запрос принят для обработки. Используйте URL-адрес в заголовке расположения, чтобы повторить попытку или получить доступ к результатам. Headers Location: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Имя

Тип

Описание

200 OK

ReverseSearchAddressBatchProcessResult

ОК

202 Accepted

Поддерживается только для асинхронного запроса. Запрос принят: запрос принят для обработки. Используйте URL-адрес в заголовке расположения, чтобы повторить попытку или получить доступ к результатам.

Headers

Location: string

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечание

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами .
объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Status code:: 202

Определения

Имя	Описание
Address	Адрес результата
AddressRanges	Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
BoundingBox	Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.
BoundingBoxCompassNotation	Ограничивающий прямоугольник расположения.
Brand	Торговая марка, связанная с poi
Classification	Классификация возвращаемого poI
ClassificationName	Имя классификации
DataSources	Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon.
Entity	Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
EntryPoint	Точка входа для возвращаемого poI.
EntryPointType	Тип точки входа. Значение может быть main или дополнительным.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GeographicEntityType	Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
Geometry	Сведения о геометрической форме результата. Присутствует, только если тип == Geography.
LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
MatchType	Типы совпадений для операции обратного поиска по адресу.
OperatingHours	Часы работы для POI (достопримечательностей).
OperatingHoursTime	Представляет дату и время
OperatingHoursTimeRange	Открытый диапазон времени для дня
PointOfInterest	Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
PointOfInterestCategorySet	Категория POI
QueryType	Тип возвращаемого запроса: NEARBY или NON_NEAR.
Response	Результат запроса. SearchAddressResult, если запрос выполнен успешно, в противном случае — ErrorResponse.
ReverseSearchAddressBatchItem	Элемент, возвращенный вызовом обратной пакетной службы Поиск address.
ReverseSearchAddressBatchProcessResult	Этот объект возвращается из успешного вызова обратной пакетной службы Поиск address.
SearchAddressResultItem	Результирующий объект для ответа API Поиск.
SearchAddressResultType	Одно из двух значений: POI Улица Географический регион Точечный адрес Диапазон адресов Перекресток
SearchSummary	Объект Summary для ответа API Поиск.
Summary	Сводка результатов пакетного запроса

Address

Адрес результата

Имя	Тип	Описание
boundingBox	BoundingBoxCompassNotation	Ограничивающий прямоугольник расположения.
buildingNumber	string	Номер здания на улице. НЕ РЕКОМЕНДУЕТСЯ, используйте streetNumber.
country	string	название страны или региона
countryCode	string	Страна (примечание. Это двухбуквенный код, а не название страны или региона.)
countryCodeISO3	string	Код страны ISO alpha-3
countrySecondarySubdivision	string	Округ
countrySubdivision	string	Область, республика, край
countrySubdivisionCode	string	`countrySubdivisionCode` с префиксом `countryCode` ( countryCode-countrySubdivisionCode ) и дефисом формируется код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио.
countrySubdivisionName	string	Полное имя первого уровня административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлено в сокращенном виде. Поддерживается только для США, Канады и Соединенного Королевства.
countryTertiarySubdivision	string	Именованной области
crossStreet	string	Название пересекаемой улицы.
extendedPostalCode	string	Расширенный почтовый индекс (доступность зависит от региона).
freeformAddress	string	Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата, или, в случае страны или региона, полного названия страны или региона.
localName	string	Компонент адреса, представляющий имя географической области или местности, которая группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для построения `freeformAddress` свойства . `localName` представляет почтовый муниципалитет. В зависимости от расположения — `localName` это общеизвестное название города или города. Для общего названия города используйте `localName` вместо `municipality`.
municipality	string	Город или город Примечание. `municipality` Представляет жилой муниципалитет. В зависимости от расположения значение `municipality` может отличаться от общего названия города или города. Для общего названия города или города рекомендуется `localName` использовать значение вместо `municipality` значения .
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Район — это географически локализованная область в пределах города или города с отличительными характеристиками и социальными взаимодействиями между жителями.
postalCode	string	Почтовый индекс/ почтовый индекс
routeNumbers	string[]	Коды, используемые для однозначной идентификации улицы
street	string	Название улицы. НЕ РЕКОМЕНДУЕТСЯ, используйте streetName.
streetName	string	Название улицы.
streetNameAndNumber	string	Название и номер улицы.
streetNumber	string	Номер здания на улице.

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.

Имя	Тип	Описание
from	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
rangeLeft	string	Диапазон адресов на левой стороне улицы.
rangeRight	string	Диапазон адресов на правой стороне улицы.
to	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBox

Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.

Имя	Тип	Описание
btmRightPoint	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Имя	Тип	Описание
entity	Entity	Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
northEast	string	Северо-восточная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой с разделиниями-запятыми
southWest	string	Юго-западная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой, разделенной запятыми

Brand

Торговая марка, связанная с poi

Имя	Тип	Описание
name	string	Название торговой марки

Classification

Классификация возвращаемого poI

Имя	Тип	Описание
code	string	Свойство Code
names	ClassificationName[]	Массив имен

ClassificationName

Имя классификации

Имя	Тип	Описание
name	string	Name - свойство
nameLocale	string	Свойство "Языковой стандарт имени"

DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon.

Имя	Тип	Описание
geometry	Geometry	Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

Имя	Тип	Описание
position	string	Сущность Position

EntryPoint

Точка входа для возвращаемого poI.

Имя	Тип	Описание
position	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
type	EntryPointType	Тип точки входа. Значение может быть main или дополнительным.

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

Имя	Тип	Описание
main	string
minor	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.

Имя	Тип	Описание
Country	string	название страны или региона
CountrySecondarySubdivision	string	Округ
CountrySubdivision	string	Область, республика, край
CountryTertiarySubdivision	string	Именованной области
Municipality	string	Город или город
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Районе
PostalCodeArea	string	Почтовый индекс/ почтовый индекс

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Имя	Тип	Описание
id	string	Передайте его как geometryId в API получения Поиск Polygon, чтобы получить геометрическую информацию для этого результата.

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

Имя	Тип	Описание
lat	number	Свойство Latitude
lon	number	Свойство Longitude

MatchType

Типы совпадений для операции обратного поиска по адресу.

Имя	Тип	Описание
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Часы работы для POI (достопримечательностей).

Имя	Тип	Описание
mode	string	Значение, используемое в запросе: none или nextSevenDays
timeRanges	OperatingHoursTimeRange[]	Список диапазонов времени на следующие 7 дней

OperatingHoursTime

Представляет дату и время

Имя	Тип	Описание
date	string	Представляет текущую дату календаря в часовом поясе POI, например 07.02.2019.
hour	integer	Часы в 24-часовом формате по местному времени POI; Возможные значения: от 0 до 23.
minute	integer	Минуты относятся к местному времени POI; Возможные значения: от 0 до 59.

OperatingHoursTimeRange

Открытый диапазон времени для дня

Имя	Тип	Описание
endTime	OperatingHoursTime	Точка в диапазоне следующих 7 дней при закрытии заданного POI или начало диапазона, если он был закрыт до диапазона.
startTime	OperatingHoursTime	Точка в диапазоне следующих 7 дней, когда открывается данный poI, или начало диапазона, если он был открыт до диапазона.

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

Имя	Тип	Описание
brands	Brand[]	Массив торговых марок. Имя торговой марки для возвращаемого poI.
categories	string[]	Массив категорий
categorySet	PointOfInterestCategorySet[]	Список наиболее конкретных категорий POI
classifications	Classification[]	Массив классификации
name	string	Имя свойства POI
openingHours	OperatingHours	Часы работы для POI (достопримечательностей).
phone	string	Свойство номера телефона
url	string	Свойство URL-адреса веб-сайта

PointOfInterestCategorySet

Категория POI

Имя	Тип	Описание
id	integer	Идентификатор категории

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Имя	Тип	Описание
NEARBY	string	Поиск выполнено вокруг определенной широты и долготы с заданным радиусом
NON_NEAR	string	Поиск выполнялась глобально без смещения к определенной широте и долготе без определенного радиуса

Response

Результат запроса. SearchAddressResult, если запрос выполнен успешно, в противном случае — ErrorResponse.

Имя	Тип	Описание
error	ErrorDetail	Объект error.
results	SearchAddressResultItem[]	Список результатов Поиск API.
summary	SearchSummary	Объект Summary для ответа API Поиск

ReverseSearchAddressBatchItem

Элемент, возвращенный вызовом обратной пакетной службы Поиск address.

Имя	Тип	Описание
response	Response	Результат запроса. SearchAddressReverseResponse, если запрос выполнен успешно, в противном случае — ErrorResponse.
statusCode	integer	Код состояния HTTP-запроса.

ReverseSearchAddressBatchProcessResult

Этот объект возвращается из успешного вызова обратной пакетной службы Поиск address.

Имя	Тип	Описание
batchItems	ReverseSearchAddressBatchItem[]	Массив, содержащий пакетные результаты.
summary	Summary	Сводка результатов пакетного запроса

SearchAddressResultItem

Результирующий объект для ответа API Поиск.

Имя	Тип	Описание
address	Address	Адрес результата
addressRanges	AddressRanges	Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
dataSources	DataSources	Необязательный раздел. Идентификатор геометрии ссылки для использования с API получения Поиск Polygon.
detourTime	integer	Время объезда в секундах. Возвращается только для вызовов API Поиск Вдоль маршрута.
dist	number	Расстояние по прямой линии между результатом и расположением геобия в метрах.
entityType	GeographicEntityType	Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
entryPoints	EntryPoint[]	Массив точек входа. Они описывают типы входов, доступных на месте. Тип может быть "main" для main входов, таких как входная дверь или вестибюль, и "незначительный" для боковых и задних дверей.
id	string	Свойство Id
info	string	Сведения об исходном источнике данных result. Используется для запросов в службу поддержки.
matchType	MatchType	Сведения о типе соответствия. Одно из двух значений: Адресная точка HouseNumberRange Улица
poi	PointOfInterest	Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
position	LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
score	number	Значение в результирующем наборе, указывающее относительную оценку сопоставления между результатами. С его помощью можно определить, что результат x в два раза выше, чем результат y, если значение x равно 2x значению y. Значения различаются в разных запросах и предназначены только как относительное значение для одного результирующих наборов.
type	SearchAddressResultType	Одно из двух значений: POI Улица Географический регион Точечный адрес Диапазон адресов Перекресток
viewport	BoundingBox	Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.

SearchAddressResultType

Одно из двух значений:

POI
Улица
Географический регион
Точечный адрес
Диапазон адресов
Перекресток

Имя	Тип	Описание
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Объект Summary для ответа API Поиск.

Имя	Тип	Описание
fuzzyLevel	integer	Максимальный уровень нечеткости, необходимый для предоставления результатов.
geoBias	LatLongPairAbbreviated	Указание того, что внутренняя поисковая система применила геопространственный смещение для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, задав параметры lat и lon, если они доступны. В других случаях она является чисто внутренней.
limit	integer	Максимальное число возвращаемых ответов
numResults	integer	Количество результатов в ответе.
offset	integer	Начальная смещение возвращаемых результатов в полном результирующем наборе.
query	string	Параметр запроса, который использовался для получения этих результатов поиска.
queryTime	integer	Время, затраченное на разрешение запроса, в миллисекундах.
queryType	QueryType	Тип возвращаемого запроса: NEARBY или NON_NEAR.
totalResults	integer	Общее число найденных результатов.

Summary

Сводка результатов пакетного запроса

Имя	Тип	Описание
successfulRequests	integer	Количество успешных запросов в пакете
totalRequests	integer	Общее количество запросов в пакете

Search - Get Search Address Reverse Batch

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

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

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

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

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

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Scopes

subscription-key

SAS Token

Примеры

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

Sample Response

Определения

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Дополнительные ресурсы