Search - Get Search POI Category Tree
Используйте для получения списка поддерживаемых категорий и подкатегорий точек интереса (POI).
API Get Search POI Category Tree
— это HTTP-запрос GET
, который предоставляет полный список поддерживаемых категорий и подкатегорий точек интереса вместе с их переводами и синонимами. Возвращаемое содержимое можно использовать для предоставления более значимых результатов с помощью других API службы Поиск, таких как Получение Поиск POI.
GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0
GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0&language={language}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
format
|
path | True |
Json |
Требуемый формат ответа. Поддерживается только формат |
api-version
|
query | True |
string |
Номер версии API Azure Maps |
language
|
query |
string |
Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, за исключением NGT и NGT-Latn. Языковой тег не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию (английский). Дополнительные сведения см. в разделе Поддерживаемые языки . |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Point |
ОК |
Other Status Codes |
Error |
Произошла непредвиденная ошибка. |
Безопасность
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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.
Type:
apiKey
In:
header
Примеры
Get the POI Category Tree (only partial response shown below)
Sample Request
GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0
Sample Response
{
"poiCategories": [
{
"id": 7320,
"name": "Sports Center",
"childCategoryIds": [
7320002,
7320003,
7320005
],
"synonyms": [
"Gym",
"Indoors Sports",
"Sports Centre"
]
},
{
"id": 7374,
"name": "Stadium",
"childCategoryIds": [
7374002,
7374009,
7374012,
7374003,
7374010,
7374005,
7374008,
7374011,
7374006,
7374014,
7374013,
7374007,
7374004
],
"synonyms": [
"Arena",
"Gymnasium",
"Sports Ground",
"Sports Stadium"
]
},
{
"id": 7315,
"name": "Restaurant",
"childCategoryIds": [
7315081,
7315002,
7315082,
7315003,
7315083,
7315084,
7315085,
7315062,
7315086,
7315004,
7315146,
7315005,
7315087,
7315006,
7315007,
7315088,
7315089,
7315072,
7315008,
7315142,
7315090,
7315091,
7315147,
7315009,
7315092,
7315010,
7315011,
7315070,
7315093,
7315012,
7315094,
7315095,
7315063,
7315013,
7315096,
7315097,
7315068,
7315098,
7315099,
7315057,
7315079,
7315014,
7315100,
7315101,
7315132,
7315102,
7315133,
7315015,
7315016,
7315104,
7315134,
7315017,
7315071,
7315018,
7315019,
7315020,
7315054,
7315069,
7315021,
7315058,
7315052,
7315022,
7315078,
7315023,
7315024,
7315073,
7315105,
7315065,
7315106,
7315025,
7315066,
7315026,
7315027,
7315028,
7315067,
7315029,
7315030,
7315107,
7315135,
7315108,
7315031,
7315109,
7315032,
7315033,
7315034,
7315110,
7315074,
7315136,
7315111,
7315112,
7315075,
7315035,
7315127,
7315061,
7315036,
7315037,
7315129,
7315038,
7315130,
7315039,
7315041,
7315131,
7315040,
7315143,
7315042,
7315113,
7315114,
7315115,
7315043,
7315053,
7315055,
7315056,
7315116,
7315117,
7315080,
7315139,
7315064,
7315140,
7315044,
7315045,
7315118,
7315046,
7315148,
7315119,
7315047,
7315120,
7315059,
7315145,
7315076,
7315121,
7315048,
7315122,
7315123,
7315049,
7315124,
7315050,
7315125,
7315051,
7315126,
7315060,
7315149
],
"synonyms": [
"Dining",
"Eatery",
"Eating House",
"Eating Place"
]
}
]
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Json |
Требуемый формат ответа. Поддерживается только формат |
Point |
Результат категории POI |
Point |
Этот объект возвращается из успешного вызова дерева категорий POI. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Error |
Дополнительные сведения об ошибке. |
code |
string |
Код ошибки. |
details |
Error |
Сведения об ошибке. |
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Error |
Объект ошибки. |
JsonFormat
Требуемый формат ответа. Поддерживается только формат json
.
Имя | Тип | Описание |
---|---|---|
json |
string |
PointOfInterestCategory
Результат категории POI
Имя | Тип | Описание |
---|---|---|
childCategoryIds |
integer[] |
Массив идентификаторов дочерних категорий |
id |
integer |
Уникальный идентификатор категории. Идентификатор можно использовать для ограничения результатов поиска определенными категориями с помощью других API службы Поиск, таких как Получение Поиск POI. |
name |
string |
Имя категории |
synonyms |
string[] |
Массив альтернативных имен категории |
PointOfInterestCategoryTreeResult
Этот объект возвращается из успешного вызова дерева категорий POI.
Имя | Тип | Описание |
---|---|---|
poiCategories |
Point |
Массив категорий |