Search - Get Search POI Category Tree

Ссылка

Служба:: Maps

Версия API:: 1.0

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

API Get Search POI Category Tree — это http-запрос GET, который предоставляет полный список поддерживаемых категорий и подкатегорий интересов (POI) вместе с их переводами и синонимами. Возвращаемое содержимое можно использовать для предоставления более значимых результатов с помощью других 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	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.
language	query		string	Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, кроме NGT и NGT-Latn. Тег языка не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию (английский). Дополнительные сведения см. в поддерживаемых языках.

format

path

True

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

api-version

query

True

string

Номер версии API Azure Maps.

language

query

string

Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, кроме NGT и NGT-Latn. Тег языка не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию (английский).

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

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

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

Ответы

Имя	Тип	Описание
200 OK	PointOfInterestCategoryTreeResult	ХОРОШО
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

Примеры

Get the POI Category Tree (only partial response shown below)

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

HTTP

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0

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

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

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
PointOfInterestCategory	Результат категории POI
PointOfInterestCategoryTreeResult	Этот объект возвращается из успешного вызова дерева категорий POI

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

JsonFormat

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

Требуемый формат ответа. Поддерживается только json формат.

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

PointOfInterestCategory

Object

Результат категории POI

Имя	Тип	Описание
childCategoryIds	integer[]	Массив идентификаторов дочерних категорий
id	integer	Уникальный идентификатор категории. Идентификатор можно использовать для ограничения результатов поиска определенным категориям с помощью других API-интерфейсов службы поиска, таких как получение poI поиска.
name	string	Имя категории
synonyms	string[]	Массив альтернативных имен категории

PointOfInterestCategoryTreeResult

Object

Этот объект возвращается из успешного вызова дерева категорий POI

Имя	Тип	Описание
poiCategories	PointOfInterestCategory[]	Массив категорий

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

Search - Get Search POI Category Tree

Параметры URI

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

Ответы

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

AADToken

Области

subscription-key

SAS Token

Примеры

Get the POI Category Tree (only partial response shown below)

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

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

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult