Search - Get Search POI Category Tree

Riferimento

Servizio:: Maps

Versione API:: 1.0

Usare per ottenere un elenco di categorie di punti di interesse (POI) supportate e sottocategorie.

L'API Get Search POI Category Tree è una richiesta HTTP GET che fornisce un elenco completo di categorie di punti di interesse (POI) supportate e sottocategorie insieme alle relative traduzioni e sinonimi. Il contenuto restituito può essere usato per fornire risultati più significativi tramite altre API del servizio Search, ad esempio Get Search POI.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
language	query		string	Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di linguaggio IETF supportati, ad eccezione di NGT e NGT-Latn. Il tag di lingua è senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita (inglese). Per informazioni dettagliate, vedere Lingue supportate .

format

path

True

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

api-version

query

True

string

Numero di versione dell'API Mappe di Azure.

language

query

string

Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di linguaggio IETF supportati, ad eccezione di NGT e NGT-Latn. Il tag di lingua è senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita (inglese).

Per informazioni dettagliate, vedere Lingue supportate .

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	PointOfInterestCategoryTreeResult	OK
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Nota

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .
L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID.
Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
L'utilizzo dell'SDK Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
Per altre informazioni su Microsoft Identity Platform, vedere panoramica Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning quando si crea un account Mappe di Azure nell'portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio delle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

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

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      ]
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.
PointOfInterestCategory	Risultato della categoria POI
PointOfInterestCategoryTreeResult	Questo oggetto viene restituito da una chiamata ad albero delle categorie POI riuscita

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

Nome	Tipo	Descrizione
json	string	Formato di interscambio dati dell'oggetto JavaScript

PointOfInterestCategory

Risultato della categoria POI

Nome	Tipo	Descrizione
childCategoryIds	integer[]	Matrice di ID categoria figlio
id	integer	ID univoco per la categoria. L'ID può essere usato per limitare i risultati della ricerca a categorie specifiche tramite altre API del servizio Search, ad esempio Get Search POI.
name	string	Nome della categoria.
synonyms	string[]	Matrice di nomi alternativi della categoria

PointOfInterestCategoryTreeResult

Questo oggetto viene restituito da una chiamata ad albero delle categorie POI riuscita

Nome	Tipo	Descrizione
poiCategories	PointOfInterestCategory[]	Matrice categorie

Condividi tramite

Search - Get Search POI Category Tree

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

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

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult

Risorse aggiuntive