Search - Get Search POI
Usare per cercare i punti di interesse in base al nome.
L'API Points of Interest (POI) Search
è una richiesta http GET
che consente di richiedere i risultati dei punti di interesse in base al nome. Supporta anche parametri di query aggiuntivi, ad esempio lingua e filtro dei risultati in base all'area di interesse guidata dal paese/area geografica o dal rettangolo di selezione. L'endpoint restituirà solo i risultati dei punti di interesse corrispondenti alla stringa di query. La risposta include dettagli di punti di interesse, ad esempio indirizzo, posizione delle coordinate e categoria.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
format
|
path | True |
Formato desiderato della risposta. Il valore può essere json o xml. |
|
api-version
|
query | True |
string |
Numero di versione dell'API mappe di Azure. |
query
|
query | True |
string |
Il nome del punto di interesse da cercare (ad esempio, "statua della libertà", "starbucks"), deve essere codificato correttamente con URL. |
brand
|
query |
string[] |
Elenco delimitato da virgole di nomi di marchi che possono essere usati per limitare il risultato a marchi specifici. L'ordine degli articoli non è importante. Quando vengono forniti più marchi, verranno restituiti solo i risultati che appartengono (almeno) a uno degli elenchi forniti. I marchi che contengono un oggetto "," nel loro nome devono essere inseriti tra virgolette. Esempi di utilizzo: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar |
|
btm
|
query |
string |
Posizione inferiore destra del rettangolo di selezione. Ad esempio 37.553,-122.453 |
|
category
|
query |
integer[] |
Elenco delimitato da virgole di ID set di categorie che possono essere usati per limitare il risultato a categorie di punti di interesse specifiche. L'ordine ID non è importante. Il numero massimo di valori di
|
|
connector
|
query |
Elenco delimitato da virgole di tipi di connettori che possono essere usati per limitare il risultato alla stazione di veicoli elettrici che supporta tipi di connettore specifici. L'ordine degli articoli non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono (almeno) a uno degli elenchi forniti. I tipi di connettore disponibili sono:
Esempi di utilizzo: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Stringa delimitata da virgole di codici paese/area geografica, ad esempio FR,ES. In questo modo la ricerca verrà limitata ai paesi/aree geografiche specificati |
|
extended
|
query |
Indici per i quali i codici postali estesi devono essere inclusi nei risultati. Gli indici disponibili sono: punto di interesse = Punti di interesse Il valore deve essere poi o Nessuna per disabilitare i codici postali estesi. Per impostazione predefinita, sono inclusi i codici postali estesi. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=None Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area. |
||
language
|
query |
string |
Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di lingua IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita. Per informazioni dettagliate, vedere lingue supportate. |
|
lat
|
query |
number (double) |
Latitudine in cui i risultati devono essere distorti. Ad esempio 37.337 |
|
limit
|
query |
integer minimum: 1maximum: 100 |
Numero massimo di risposte che verranno restituite. Impostazione predefinita: 10, minimo: 1 e massimo: 100 |
|
lon
|
query |
number (double) |
Longitudine in cui i risultati devono essere distorti. Ad esempio -121.89 |
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Offset iniziale dei risultati restituiti all'interno del set di risultati completo. Impostazione predefinita: 0 |
|
opening
|
query |
Ore di funzionamento per un punto di interesse (Punti di interesse). La disponibilità delle ore di funzionamento varia in base ai dati disponibili. Se non viene superato, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays |
||
radius
|
query |
integer |
Raggio in metri da cui limitare i risultati all'area definita |
|
top
|
query |
string |
Posizione superiore sinistra del rettangolo di selezione. Ad esempio 37.553,-122.453 |
|
typeahead
|
query |
boolean |
Booleano. Se il flag typeahead è impostato, la query verrà interpretata come input parziale e la ricerca passerà alla modalità predittiva |
|
view
|
query |
Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
x-ms-client-id |
string |
Specifica quale 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 dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Va bene |
|
Other Status Codes |
Errore imprevisto. |
Sicurezza
AADToken
Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A 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 le API REST di Mappe di Azure.
Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Nota
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione Maps. - Il
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 il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
- L'utilizzo della 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 di 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 effettuato il provisioning quando si Creare un account di Mappe di Azure nel 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 applicazioni client riservate per accedere alle API REST di 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 List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le 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
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Esempio di richiesta
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Risposta di esempio
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Address |
Indirizzo del risultato |
Address |
Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi. |
Bounding |
Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione. |
Bounding |
Rettangolo di selezione della posizione. |
Brand |
Il marchio associato al punto di interesse |
Classification |
Classificazione per il punto di interesse restituito |
Classification |
Nome della classificazione |
Data |
Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon. |
Electric |
Elenco delimitato da virgole di tipi di connettori che possono essere usati per limitare il risultato alla stazione di veicoli elettrici che supporta tipi di connettore specifici. L'ordine degli articoli non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono (almeno) a uno degli elenchi forniti. I tipi di connettore disponibili sono:
Esempi di utilizzo: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione. |
Entry |
Punto di ingresso per il punto di interesse restituito. |
Entry |
Tipo di punto di ingresso. Il valore può essere principale o secondaria. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Geographic |
Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile. |
Geometry |
Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography. |
Lat |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
Localized |
Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate. |
Match |
Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa. |
Operating |
Ore di apertura per un punto di interesse (punti di interesse). |
Operating |
Ore di funzionamento per un punto di interesse (Punti di interesse). La disponibilità delle ore di funzionamento varia in base ai dati disponibili. Se non viene superato, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays |
Operating |
Rappresenta una data e un'ora |
Operating |
Aprire l'intervallo di tempo per un giorno |
Point |
Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni. |
Point |
Categoria punti di interesse |
Point |
Indici per i quali i codici postali estesi devono essere inclusi nei risultati. Gli indici disponibili sono: punto di interesse = Punti di interesse Il valore deve essere poi o Nessuna per disabilitare i codici postali estesi. Per impostazione predefinita, sono inclusi i codici postali estesi. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=None Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area. |
Query |
Tipo di query restituito: NEARBY o NON_NEAR. |
Response |
Formato desiderato della risposta. Il valore può essere json o xml. |
Search |
Questo oggetto viene restituito dalle chiamate di ricerca riuscite. |
Search |
Oggetto Result per una risposta dell'API di ricerca. |
Search |
Uno dei seguenti:
|
Search |
Oggetto riepilogo per una risposta dell'API di ricerca. |
Address
Indirizzo del risultato
Nome | Tipo | Descrizione |
---|---|---|
boundingBox |
Rettangolo di selezione della posizione. |
|
buildingNumber |
string |
Numero dell'edificio sulla strada. DEPRECATO, usare invece streetNumber. |
country |
string |
nome paese/area geografica |
countryCode |
string |
Paese (Nota: si tratta di un codice di due lettere, non di un nome paese/area geografica. |
countryCodeISO3 |
string |
Codice paese ISO alfa-3 |
countrySecondarySubdivision |
string |
Contea |
countrySubdivision |
string |
Stato o Provincia |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Nome completo di un primo livello di gerarchia amministrativa paese/area geografica. Questo campo viene visualizzato solo nel caso in cui countrySubdivision venga presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito. |
countryTertiarySubdivision |
string |
Area denominata |
crossStreet |
string |
Il nome della strada da attraversare. |
extendedPostalCode |
string |
Codice postale esteso (la disponibilità dipende dall'area). |
freeformAddress |
string |
Riga di indirizzo formattata in base alle regole di formattazione del paese o dell'area geografica di un risultato oppure, nel caso di un paese o area geografica, il nome completo del paese o dell'area geografica. |
localName |
string |
Componente dell'indirizzo che rappresenta il nome di un'area geografica o di una località che raggruppa più oggetti indirizzabili a scopo di indirizzamento, senza essere un'unità amministrativa. Questo campo viene usato per compilare la proprietà |
municipality |
string |
Città/Città |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
Un quartiere è un'area geograficamente localizzata all'interno di una città o di una città con caratteristiche distintive e interazioni sociali tra gli abitanti. |
postalCode |
string |
Codice postale/Cap |
routeNumbers |
string[] |
I codici usati per identificare in modo univoco la strada |
street |
string |
Nome della strada. DEPRECATO, usare invece streetName. |
streetName |
string |
Nome della strada. |
streetNameAndNumber |
string |
Nome e numero della strada. |
streetNumber |
string |
Numero dell'edificio sulla strada. |
AddressRanges
Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.
Nome | Tipo | Descrizione |
---|---|---|
from |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
rangeLeft |
string |
Intervallo di indirizzi sul lato sinistro della strada. |
rangeRight |
string |
Intervallo di indirizzi sul lato destro della strada. |
to |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
BoundingBox
Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.
Nome | Tipo | Descrizione |
---|---|---|
btmRightPoint |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
topLeftPoint |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
BoundingBoxCompassNotation
Rettangolo di selezione della posizione.
Nome | Tipo | Descrizione |
---|---|---|
entity |
Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione. |
|
northEast |
string |
Latitudine nord-est, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole |
southWest |
string |
Latitudine sud-ovest, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole |
Brand
Il marchio associato al punto di interesse
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome del marchio |
Classification
Classificazione per il punto di interesse restituito
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Proprietà del codice |
names |
Matrice nomi |
ClassificationName
Nome della classificazione
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Name - proprietà |
nameLocale |
string |
Proprietà Delle impostazioni locali name |
DataSources
Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon.
Nome | Tipo | Descrizione |
---|---|---|
geometry |
Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography. |
ElectricVehicleConnector
Elenco delimitato da virgole di tipi di connettori che possono essere usati per limitare il risultato alla stazione di veicoli elettrici che supporta tipi di connettore specifici. L'ordine degli articoli non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono (almeno) a uno degli elenchi forniti.
I tipi di connettore disponibili sono:
-
StandardHouseholdCountrySpecific
: si tratta dei connettori per la famiglia standard per una determinata area. Sono tutte singole fasi AC e tensione standard e amperage standard. Vedere anche: tipi di socket Plug & - World Standards. -
IEC62196Type1
- Connettore di tipo 1 come definito nello standard IEC 62196-2. Chiamato anche Yamak dopo il produttore originale o SAE J1772 dopo lo standard che l'ha pubblicato per la prima volta. Usato principalmente in combinazione con una singola fase 120V o fino a 240 V a fase singola. -
IEC62196Type1CCS
: connettore combinato basato sul tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc aggiuntivi diretti per consentire la ricarica rapida del controller di dominio. -
IEC62196Type2CableAttached
: connettore di tipo 2 come definito nello standard IEC 62196-2. Fornito come cavo e collegato al punto di ricarica. -
IEC62196Type2Outlet
: connettore di tipo 2 come definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica. -
IEC62196Type2CCS
: connettore combinato basato sul tipo 2 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore type 2, come definito nello standard IEC 62196-2, con due contatti dc aggiuntivi diretti per consentire la ricarica rapida del controller di dominio. -
IEC62196Type3
- Connettore di tipo 3 come definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Usato principalmente in combinazione con un'infrastruttura a tre fasi fino a 240V o fino a 420V. -
Chademo
- Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. Per questo motivo è noto anche come connettore DEL PARAMETRO. Supporta la ricarica rapida del controller di dominio. -
IEC60309AC1PhaseBlue
- Connettore Industrial Blue è un connettore definito nello standard IEC 60309. A volte viene definito come da una combinazione dello standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h". -
IEC60309DCWhite
- Connettore Industrial White è un connettore DC definito nello standard IEC 60309. -
Tesla
: il connettore Tesla è il connettore Tesla Supercharger specifico a livello di area. Cioè, si riferisce al connettore proprietario di Tesla, talvolta definito porta Tesla principalmente limitata al Nord America o al tipo 2 modificato (DC over Type 2) in Europa.
Esempi di utilizzo:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Valore | Descrizione |
---|---|
Chademo |
Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. Per questo motivo è noto anche come connettore DEL PARAMETRO. Supporta la ricarica rapida del controller di dominio. |
IEC60309AC1PhaseBlue |
Il connettore Industrial Blue è un connettore definito nello standard IEC 60309. A volte viene definito come da una combinazione dello standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h". |
IEC60309DCWhite |
Il connettore Industrial White è un connettore DC definito nello standard IEC 60309. |
IEC62196Type1 |
Connettore di tipo 1 come definito nello standard IEC 62196-2. Chiamato anche Yamak dopo il produttore originale o SAE J1772 dopo lo standard che l'ha pubblicato per la prima volta. Usato principalmente in combinazione con una singola fase 120V o fino a 240 V a fase singola. |
IEC62196Type1CCS |
Connettore combinato basato sul tipo 1 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore Type 1, come definito nello standard IEC 62196-2, con due contatti dc aggiuntivi diretti per consentire la ricarica rapida del controller di dominio. |
IEC62196Type2CCS |
Connettore combinato basato sul tipo 2 come definito nello standard IEC 62196-3. Il connettore si basa sul connettore type 2, come definito nello standard IEC 62196-2, con due contatti dc aggiuntivi diretti per consentire la ricarica rapida del controller di dominio. |
IEC62196Type2CableAttached |
Connettore di tipo 2 come definito nello standard IEC 62196-2. Fornito come cavo e collegato al punto di ricarica |
IEC62196Type2Outlet |
Connettore di tipo 2 come definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica. |
IEC62196Type3 |
Connettore di tipo 3 come definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Usato principalmente in combinazione con un'infrastruttura a tre fasi fino a 240V o fino a 420V. |
StandardHouseholdCountrySpecific |
Questi sono i connettori per la famiglia standard per una determinata area. Sono tutte singole fasi AC e tensione standard e amperage standard. Vedere anche: tipi di socket plug & - Standard globali |
Tesla |
Il connettore Tesla è il connettore Tesla Supercharger specifico a livello di area. Cioè, si riferisce al connettore proprietario di Tesla, talvolta definito porta Tesla principalmente limitata al Nord America o al tipo 2 modificato (DC over Type 2) in Europa. |
Entity
Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
Valore | Descrizione |
---|---|
position |
Entità Position |
EntryPoint
Punto di ingresso per il punto di interesse restituito.
Nome | Tipo | Descrizione |
---|---|---|
position |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
type |
Tipo di punto di ingresso. Il valore può essere principale o secondaria. |
EntryPointType
Tipo di punto di ingresso. Il valore può essere principale o secondaria.
Valore | Descrizione |
---|---|
main | |
minor |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
GeographicEntityType
Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.
Valore | Descrizione |
---|---|
Country |
nome paese/area geografica |
CountrySecondarySubdivision |
Contea |
CountrySubdivision |
Stato o Provincia |
CountryTertiarySubdivision |
Area denominata |
Municipality |
Città/Città |
MunicipalitySubdivision |
Sub/Super City |
Neighbourhood |
Quartiere |
PostalCodeArea |
Codice postale/Cap |
Geometry
Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Passare questo valore come geometryId all'API get search polygon per recuperare le informazioni di geometria per questo risultato. |
LatLongPairAbbreviated
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
Nome | Tipo | Descrizione |
---|---|---|
lat |
number (double) |
Proprietà Latitude |
lon |
number (double) |
Longitudine - proprietà |
LocalizedMapView
Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN.
Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.
Valore | Descrizione |
---|---|
AE |
Emirati Arabi Uniti (visualizzazione Araba) |
AR |
Argentina (vista argentina) |
Auto |
Restituisce i dati della mappa in base all'indirizzo IP della richiesta. |
BH |
Bahrein (vista araba) |
IN |
India (vista indiana) |
IQ |
Iraq (visualizzazione araba) |
JO |
Giordania (visualizzazione araba) |
KW |
Kuwait (vista araba) |
LB |
Libano (vista araba) |
MA |
Marocco (vista marocchina) |
OM |
Oman (vista araba) |
PK |
Pakistan (vista pakistana) |
PS |
Autorità palestinese (visualizzazione araba) |
QA |
Qatar (vista araba) |
SA |
Arabia Saudita (vista araba) |
SY |
Siria (visualizzazione araba) |
Unified |
Visualizzazione unificata (altri) |
YE |
Yemen (vista araba) |
MatchType
Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.
Valore | Descrizione |
---|---|
AddressPoint | |
HouseNumberRange | |
Street |
OperatingHours
Ore di apertura per un punto di interesse (punti di interesse).
Nome | Tipo | Descrizione |
---|---|---|
mode |
string |
Valore usato nella richiesta: nessuno o "nextSevenDays" |
timeRanges |
Elenco di intervalli di tempo per i prossimi 7 giorni |
OperatingHoursRange
Ore di funzionamento per un punto di interesse (Punti di interesse). La disponibilità delle ore di funzionamento varia in base ai dati disponibili. Se non viene superato, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays
Valore | Descrizione |
---|---|
nextSevenDays |
Mostra le ore di funzionamento per la settimana successiva, a partire dal giorno corrente nell'ora locale dell'area di interesse. |
OperatingHoursTime
Rappresenta una data e un'ora
Nome | Tipo | Descrizione |
---|---|---|
date |
string |
Rappresenta la data del calendario corrente nel fuso orario dei punti di interesse, ad esempio "2019-02-07". |
hour |
integer |
Le ore sono nel formato 24 ore nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 23. |
minute |
integer |
I minuti sono nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 59. |
OperatingHoursTimeRange
Aprire l'intervallo di tempo per un giorno
Nome | Tipo | Descrizione |
---|---|---|
endTime |
Punto nell'intervallo di 7 giorni successivo quando un punto di interesse specificato viene chiuso o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo. |
|
startTime |
Punto nell'intervallo di 7 giorni successivo quando viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo. |
PointOfInterest
Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
Nome | Tipo | Descrizione |
---|---|---|
brands |
Brand[] |
Matrice di marchi. Nome del marchio per il punto di interesse restituito. |
categories |
string[] |
Matrice categorie |
categorySet |
Elenco delle categorie di punti di interesse più specifiche |
|
classifications |
Matrice di classificazione |
|
name |
string |
Nome della proprietà POI |
openingHours |
Ore di apertura per un punto di interesse (punti di interesse). |
|
phone |
string |
Proprietà numero di telefono |
url |
string |
Proprietà URL sito Web |
PointOfInterestCategorySet
Categoria punti di interesse
Nome | Tipo | Descrizione |
---|---|---|
id |
integer |
ID categoria |
PointOfInterestExtendedPostalCodes
Indici per i quali i codici postali estesi devono essere inclusi nei risultati.
Gli indici disponibili sono:
punto di interesse = Punti di interesse
Il valore deve essere poi o Nessuna per disabilitare i codici postali estesi.
Per impostazione predefinita, sono inclusi i codici postali estesi.
Esempi di utilizzo:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.
Valore | Descrizione |
---|---|
None | |
POI |
QueryType
Tipo di query restituito: NEARBY o NON_NEAR.
Valore | Descrizione |
---|---|
NEARBY |
La ricerca è stata eseguita intorno a una certa latitudine e longitudine con un raggio definito |
NON_NEAR |
La ricerca è stata eseguita a livello globale, senza distorsioni a una certa latitudine e longitudine e nessun raggio definito |
ResponseFormat
Formato desiderato della risposta. Il valore può essere json o xml.
Valore | Descrizione |
---|---|
json |
il formato dell'interscambio dati notazione oggetto JavaScript |
xml |
la extensible markup language |
SearchAddressResult
Questo oggetto viene restituito dalle chiamate di ricerca riuscite.
Nome | Tipo | Descrizione |
---|---|---|
results |
Elenco dei risultati dell'API di ricerca. |
|
summary |
Oggetto Riepilogo per una risposta dell'API di ricerca |
SearchAddressResultItem
Oggetto Result per una risposta dell'API di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
address |
Indirizzo del risultato |
|
addressRanges |
Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi. |
|
dataSources |
Sezione facoltativa. ID geometry di riferimento da usare con l'API get search polygon. |
|
detourTime |
integer |
Tempo di deviazione in secondi. Restituito solo per le chiamate all'API Search Along Route. |
dist |
number (double) |
Distanza linea retta tra il risultato e la posizione geobias in metri. |
entityType |
Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile. |
|
entryPoints |
Matrice di Punti di ingresso. Questi descrivono i tipi di ingressi disponibili nella posizione. Il tipo può essere "principale" per gli ingressi principali, ad esempio una porta anteriore, o una hall, e "minore", per porte laterali e posteriore. |
|
id |
string |
Id - proprietà |
info |
string |
Informazioni sull'origine dati originale del risultato. Usato per le richieste di supporto. |
matchType |
Informazioni sul tipo di corrispondenza. Uno dei seguenti:
|
|
poi |
Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni. |
|
position |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
score |
number (double) |
Valore all'interno di un set di risultati per indicare il punteggio di corrispondenza relativo tra i risultati. È possibile usarlo per determinare che il risultato x è il doppio delle probabilità di essere rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra le query e sono destinati solo a un valore relativo per un set di risultati. |
type |
Uno dei seguenti:
|
|
viewport |
Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione. |
SearchAddressResultType
Uno dei seguenti:
- POI (Punto di interesse)
- Via
- Geografia
- Punto di interesse
- Intervallo di indirizzi
- Incrocio
Valore | Descrizione |
---|---|
Address Range | |
Cross Street | |
Geography | |
POI | |
Point Address | |
Street |
SearchSummary
Oggetto riepilogo per una risposta dell'API di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
fuzzyLevel |
integer |
Livello massimo di fuzzy necessario per fornire risultati. |
geoBias |
Indicazione quando il motore di ricerca interno ha applicato una distorsione geospaziale per migliorare la classificazione dei risultati. In alcuni metodi, questa operazione può essere influenzata impostando i parametri lat e lon, se disponibili. In altri casi è puramente interno. |
|
limit |
integer |
Numero massimo di risposte che verranno restituite |
numResults |
integer |
Numero di risultati nella risposta. |
offset |
integer |
Offset iniziale dell'oggetto Results restituito all'interno del set di risultati completo. |
query |
string |
Parametro di query usato per produrre questi risultati della ricerca. |
queryTime |
integer |
Tempo impiegato per la risoluzione della query, espresso in millisecondi. |
queryType |
Tipo di query restituito: NEARBY o NON_NEAR. |
|
totalResults |
integer |
Numero totale di risultati trovati. |