Search - Get Search POI Category Tree
Utilize para obter uma lista de categorias e subcategorias de Pontos de Interesse (POI) suportadas.
A Get Search POI Category Tree
API é um pedido HTTP GET
que fornece uma lista completa de categorias e subcategorias de Pontos de Interesse (POI) suportadas, juntamente com as respetivas traduções e sinónimos. Os conteúdos devolvidos podem ser utilizados para fornecer resultados mais significativos através de outras APIs de Serviço Pesquisa, como Obter Pesquisa 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}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Json |
Formato pretendido da resposta. Apenas |
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
language
|
query |
string |
Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de idioma IETF suportadas, exceto NGT e NGT-Latn. A etiqueta de idioma não é sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido (inglês). Consulte idiomas suportados para obter detalhes. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Point |
OK |
Other Status Codes |
Error |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Nota
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas . - O
Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. - O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.
Type:
apiKey
In:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Type:
apiKey
In:
header
Exemplos
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"
]
}
]
}
Definições
Name | Description |
---|---|
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Json |
Formato pretendido da resposta. Apenas |
Point |
Resultado da categoria POI |
Point |
Este objeto é devolvido a partir de uma chamada bem-sucedida da Árvore da Categoria POI |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
Error |
As informações adicionais do erro. |
code |
string |
O código de erro. |
details |
Error |
Os detalhes do erro. |
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
Error |
O objeto de erro. |
JsonFormat
Formato pretendido da resposta. Apenas json
o formato é suportado.
Name | Tipo | Description |
---|---|---|
json |
string |
O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript |
PointOfInterestCategory
Resultado da categoria POI
Name | Tipo | Description |
---|---|---|
childCategoryIds |
integer[] |
Matriz de IDs de categoria subordinada |
id |
integer |
ID exclusivo para a categoria. O ID pode ser utilizado para restringir os resultados da pesquisa a categorias específicas através de outras APIs de Serviço Pesquisa, como Obter Pesquisa POI. |
name |
string |
Nome da categoria |
synonyms |
string[] |
Matriz de nomes alternativos da categoria |
PointOfInterestCategoryTreeResult
Este objeto é devolvido a partir de uma chamada bem-sucedida da Árvore da Categoria POI
Name | Tipo | Description |
---|---|---|
poiCategories |
Point |
Matriz de categorias |