Search - Get Search Address

Ссылка

Служба:: Maps

Версия API:: 1.0

Используется для получения координат широты и долготы уличного адреса в неструктурированном или входном формате запроса.

API Get Search Address — это запрос HTTP GET возвращает координаты широты и долготы при передаче в адресе улицы или имени места в качестве критерия поиска.

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

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

С использованием необязательных параметров:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
api-version	query	True	string	Номер версии API Azure Maps.
query	query	True	string	Адрес для поиска (например, "1 Microsoft way, Redmond, WA"), должен быть правильно закодирован.
btmRight	query		string	Нижнее правое положение ограничивающего прямоугольника. Например, 37.553,-122.453
countrySet	query		string[]	Разделенная запятыми строка кодов страны или региона, например FR,ES. Это ограничивает поиск указанными странами или регионами.
entityType	query		GeographicEntityType	Указывает уровень фильтрации, выполняемый в географических регионах. Сужает поиск указанных типов сущностей geography, например, возвращает только муниципалитет. Полученный ответ будет содержать идентификатор географического региона, а также тип сущности, соответствующий. Если вы предоставляете несколько сущностей в виде разделенного запятыми списка, конечная точка вернет "наименьшую доступную сущность". Возвращаемый идентификатор геометрии можно использовать для получения геометрии этого географического региона с помощью API получения много угольника поиска. Следующие параметры игнорируются при установке entityType: heading число returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Индексы, для которых расширенные почтовые коды должны быть включены в результаты. Доступные индексы: Addr = диапазоны адресов гео = географии PAD = адреса точек POI = точки интереса Str = улицы XStr = кросс-улицы (пересечения) Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или Нет для индексов. По умолчанию расширенные почтовые коды включаются для всех индексов, кроме geo. Расширенные почтовые списки для географических регионов могут быть довольно длинными, поэтому они должны быть явно запрошены при необходимости. Примеры использования: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается в виде свойства расширенного почтового индекса extendedPostalCode адреса. Доступность зависит от региона.
language	query		string	Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в поддерживаемых языках.
lat	query		number (double)	Широта, где результаты должны быть предвзятыми. Например, 37.337
limit	query		integer minimum: 1 maximum: 100	Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100
lon	query		number (double)	Долгота, где результаты должны быть предвзятыми. Например, -121.89
ofs	query		integer minimum: 0 maximum: 1900	Начальная смещение возвращаемых результатов в полном результирующем наборе. По умолчанию: 0
radius	query		integer	Радиус в метрах для результатов, которые должны быть ограничены определенной областью.
topLeft	query		string	Верхняя левая позиция ограничивающего прямоугольника. Например, 37.553,-122.453
typeahead	query		boolean	Булев. Если установлен флаг typeahead, запрос будет интерпретирован как частичный вход, и поиск введет прогнозный режим
view	query		LocalizedMapView	Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

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

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

Ответы

Имя	Тип	Описание
200 OK	SearchAddressResult	ХОРОШО
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечание.

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Образец запроса

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Пример ответа

Код состояния:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Определения

Имя	Описание
Address	Адрес результата
AddressRanges	Описывает диапазон адресов на обеих сторонах улицы для результата поиска. Включены координаты для начальных и конечных расположений диапазона адресов.
BoundingBox	Окно просмотра, охватывающее результат, представленный координатами верхнего и нижнего справа от окна просмотра.
BoundingBoxCompassNotation	Ограничивающий прямоугольник расположения.
Brand	Бренд, связанный с POI
Classification	Классификация возвращаемого POI
ClassificationName	Имя классификации
DataSources	Необязательный раздел. Идентификаторы ссылок для использования с API get Search Polygon.
Entity	Источник типа сущности ограничивающего поля. Для обратного геокодирования это всегда равно позиции.
EntryPoint	Точка входа для возвращаемого poI.
EntryPointType	Тип точки входа. Значение может быть либо основной, либо дополнительных.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeographicEntityType	Тип сущности Geography. Присутствует только в том случае, если entityType был запрошен и доступен.
Geometry	Сведения о геометрической форме результата. Только если тип == Geography.
LatLongPairAbbreviated	Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".
LocalizedMapView	Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.
MatchType	Типы совпадений для операции поиска обратного адреса.
OperatingHours	Часы работы для POI (точки интереса).
OperatingHoursTime	Представляет дату и время
OperatingHoursTimeRange	Диапазон времени открытия в течение дня
PointOfInterest	Сведения о возвращаемом POI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
PointOfInterestCategorySet	Категория POI
QueryType	Тип возвращаемого запроса: NEARBY или NON_NEAR.
ResponseFormat	Требуемый формат ответа. Значение может быть либо json, либо xml.
SearchAddressResult	Этот объект возвращается из успешных вызовов поиска.
SearchAddressResultItem	Результирующий объект для ответа API поиска.
SearchAddressResultType	Одно из: ПОИ Улица География Точечный адрес Диапазон адресов Перекресток
SearchIndexes	Индексы, для которых расширенные почтовые коды должны быть включены в результаты. Доступные индексы: Addr = диапазоны адресов гео = географии PAD = адреса точек POI = точки интереса Str = улицы XStr = кросс-улицы (пересечения) Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или Нет для индексов. По умолчанию расширенные почтовые коды включаются для всех индексов, кроме geo. Расширенные почтовые списки для географических регионов могут быть довольно длинными, поэтому они должны быть явно запрошены при необходимости. Примеры использования: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается в виде свойства расширенного почтового индекса extendedPostalCode адреса. Доступность зависит от региона.
SearchSummary	Сводный объект для ответа API поиска.

Address

Object

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

Имя	Тип	Описание
boundingBox	BoundingBoxCompassNotation	Ограничивающий прямоугольник расположения.
buildingNumber	string	Номер здания на улице. Вместо этого используйте streetNumber.
country	string	имя страны или региона
countryCode	string	Страна (примечание. Это двухбуквенный код, а не имя страны или региона.)
countryCodeISO3	string	Код страны ISO альфа-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

Object

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

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

BoundingBox

Object

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

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

BoundingBoxCompassNotation

Object

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

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

Brand

Object

Бренд, связанный с POI

Имя	Тип	Описание
name	string	Название бренда

Classification

Object

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

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

ClassificationName

Object

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

Имя	Тип	Описание
name	string	Name, свойство
nameLocale	string	Свойство Name Locale

DataSources

Object

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

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

Entity

Перечисление

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

Значение	Описание
position	Позиция сущности

EntryPoint

Object

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

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

EntryPointType

Перечисление

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

Значение	Описание
main
minor

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

GeographicEntityType

Перечисление

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

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

Geometry

Object

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

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

LatLongPairAbbreviated

Object

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

Имя	Тип	Описание
lat	number (double)	Свойство Latitude
lon	number (double)	Свойство Долготы

LocalizedMapView

Перечисление

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

Значение	Описание
AE	Объединенные Арабские Эмираты (арабское представление)
AR	Аргентина (Аргентинский вид)
Auto	Возвращает данные карты на основе IP-адреса запроса.
BH	Бахрейн (арабский вид)
IN	Индия (индийский вид)
IQ	Ирак (арабское представление)
JO	Иордания (арабское представление)
KW	Кувейт (арабский вид)
LB	Ливан (арабский вид)
MA	Марокко (Марокко)
OM	Оман (арабский вид)
PK	Пакистан (пакистанский вид)
PS	Палестинский орган (арабское представление)
QA	Катар (арабский вид)
SA	Саудовская Аравия (арабское представление)
SY	Сирия (арабский вид)
Unified	Унифицированное представление (другие)
YE	Йемен (арабское представление)

MatchType

Перечисление

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

Значение	Описание
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Часы работы для POI (точки интереса).

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

OperatingHoursTime

Object

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

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

OperatingHoursTimeRange

Object

Диапазон времени открытия в течение дня

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

PointOfInterest

Object

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

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

PointOfInterestCategorySet

Object

Категория POI

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

QueryType

Перечисление

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

Значение	Описание
NEARBY	Поиск был выполнен вокруг определенной широты и долготы с определенным радиусом
NON_NEAR	Поиск был выполнен глобально, без предвзятости к определенной широте и долготе, и никакого определенного радиуса

ResponseFormat

Перечисление

Требуемый формат ответа. Значение может быть либо json, либо xml.

Значение	Описание
json	формат обмена данными для объектов JavaScript
xml	расширяемый язык разметки

SearchAddressResult

Object

Этот объект возвращается из успешных вызовов поиска.

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

SearchAddressResultItem

Object

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

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

SearchAddressResultType

Перечисление

Одно из:

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

Значение	Описание
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Перечисление

Индексы, для которых расширенные почтовые коды должны быть включены в результаты.

Доступные индексы:

Addr = диапазоны адресов

гео = географии

PAD = адреса точек

POI = точки интереса

Str = улицы

XStr = кросс-улицы (пересечения)

Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или Нет для индексов.

По умолчанию расширенные почтовые коды включаются для всех индексов, кроме geo. Расширенные почтовые списки для географических регионов могут быть довольно длинными, поэтому они должны быть явно запрошены при необходимости.

Примеры использования:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается в виде свойства расширенного почтового индекса extendedPostalCode адреса. Доступность зависит от региона.

Значение	Описание
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Object

Сводный объект для ответа API поиска.

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

Поделиться через

Search - Get Search Address

Параметры URI

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

Ответы

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

AADToken

Области

subscription-key

SAS Token

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Образец запроса

Пример ответа

Определения

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

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