Search - Get Search POI Category
Usare per cercare i punti di interesse per categoria.
L'API Get Search POI Category
è una richiesta HTTP GET
che consente di richiedere i risultati dell'archiviazione da una determinata categoria. Utile per eseguire query sulle poi da una categoria alla volta. L'endpoint restituirà solo i risultati di punti di interesse classificati come specificato. La risposta include dettagli di punti di interesse, ad esempio indirizzo, posizione delle coordinate e classificazione.
GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/category/{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 |
La categoria di punti di interesse da cercare (ad esempio, "AIRPORT", "RESTAURANT"), deve essere codificata correttamente con URL. Le categorie principali supportate possono essere richieste chiamando Get Search API Albero delle categorie di punti di interesse. Per un elenco delle categorie disponibili, vedere Mappe di Azure categorie supportate. È consigliabile usare l'API dell'albero delle categorie Search per richiedere le categorie supportate. |
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 a (almeno) uno dell'elenco fornito. I marchi che contengono un "," nel 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 specifici. L'ordine ID non è importante. Il numero massimo 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 connettori 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: Addr = Intervalli di indirizzi Geo = Aree geografiche PAD = Indirizzi punto PUNTO di interesse = Punti di interesse Str = Strade XStr = Cross Street (intersezioni) Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice. Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici ad eccezione di Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, quindi devono essere richiesti in modo esplicito quando necessario. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,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 |
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 |
Offset iniziale dei risultati restituiti all'interno del set di risultati completo. Predefinito: 0 |
|
opening
|
query |
Ore di operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays |
||
radius
|
query |
integer |
Raggio in metri di per 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 |
Proprietà di tipo Boolean. Se il flag typeahead è impostato, la query verrà interpretata come input parziale e la ricerca passerà alla modalità predittiva |
|
view
|
query |
Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN. Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili. |
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 account 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 |
OK |
|
Other Status Codes |
Si è verificato un errore imprevisto. |
Sicurezza
AADToken
Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. 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 Mappe di Azure API REST.
Per implementare scenari, è consigliabile visualizzare i 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 Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe . - è
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, AZURE SDK o API REST.
- L'utilizzo di Mappe di Azure Web SDK 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 crea un account 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 alle 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 List SAS nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al 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 dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
Search for ATM's within 2 miles of Times Square NY and return the top 3 results
Esempio di richiesta
GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays
Risposta di esempio
{
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 28,
"numResults": 3,
"offset": 0,
"totalResults": 3696,
"fuzzyLevel": 1,
"geoBias": {
"lat": 40.758953,
"lon": -73.985263
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/7014613",
"score": 2.575,
"dist": 10.743802093311858,
"info": "search:ta:840369001846523-US",
"poi": {
"name": "FISERV MASTERMONEY",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1560",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1560 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75901,
"lon": -73.98516
},
"viewport": {
"topLeftPoint": {
"lat": 40.75991,
"lon": -73.98635
},
"btmRightPoint": {
"lat": 40.75811,
"lon": -73.98397
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75902,
"lon": -73.98522
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830011",
"score": 2.575,
"dist": 58.68107354501256,
"info": "search:ta:840369011803697-US",
"poi": {
"name": "METABANK",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1567",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1567 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75937,
"lon": -73.98569
},
"viewport": {
"topLeftPoint": {
"lat": 40.76027,
"lon": -73.98688
},
"btmRightPoint": {
"lat": 40.75847,
"lon": -73.9845
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75924,
"lon": -73.98513
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830013",
"score": 2.575,
"dist": 55.009653221373966,
"info": "search:ta:840369010525390-US",
"poi": {
"name": "ATM",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1552",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1552 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75873,
"lon": -73.98468
},
"viewport": {
"topLeftPoint": {
"lat": 40.75963,
"lon": -73.98587
},
"btmRightPoint": {
"lat": 40.75783,
"lon": -73.98349
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.7588,
"lon": -73.98492
}
}
]
}
]
}
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 di inizio e fine 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 |
Riquadro delimitatore della posizione. |
Brand |
Il marchio associato al punto di interesse |
Classification |
Classificazione per il punto di interesse restituito |
Classification |
Nome per la classificazione |
Data |
Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon. |
Electric |
Elenco delimitato da virgole di tipi di connettore che possono essere usati per limitare il risultato a Electric Vehicle Station che supporta tipi di connettore specifici. L'ordine degli elementi non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi specificati. 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, questa operazione è 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 secondario. |
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 |
Una posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
Localized |
Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN. Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili. |
Match |
Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa. |
Operating |
Orari di apertura per un punto di interesse (Punti di interesse). |
Operating |
Ore di operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays |
Operating |
Rappresenta una data e un'ora |
Operating |
Intervallo di tempo aperto per un giorno |
Point |
Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni. |
Point |
Categoria di punti di interesse |
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 da una chiamata di Search riuscita. |
Search |
Oggetto Result per una risposta API Search. |
Search |
Uno dei valori possibili:
|
Search |
Indici per i quali i codici postali estesi devono essere inclusi nei risultati. Gli indici disponibili sono: Addr = Intervalli di indirizzi Geo = Aree geografiche PAD = Indirizzi del punto POI = Punti di interesse Str = Strade XStr = Cross Street (intersezioni) Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice. Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto devono essere richiesti in modo esplicito quando necessario. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD, Addr,POI extendedPostalCodesFor=None Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area. |
Search |
Oggetto Riepilogo per una risposta API Search. |
Address
Indirizzo del risultato
Nome | Tipo | Descrizione |
---|---|---|
boundingBox |
Riquadro delimitatore della posizione. |
|
buildingNumber |
string |
Il 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 |
State or Province |
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 sia presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito. |
countryTertiarySubdivision |
string |
Area denominata |
crossStreet |
string |
Nome della strada attraversata. |
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/area geografica, il nome completo del paese o dell'area geografica. |
localName |
string |
Componente di 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 |
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 |
Cap/Cap |
routeNumbers |
string[] |
I codici utilizzati 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 |
Il 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 di inizio e fine 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
Riquadro delimitatore della posizione.
Nome | Tipo | Descrizione |
---|---|---|
entity |
Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa, questa operazione è 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à code |
names |
Matrice dei nomi |
ClassificationName
Nome per la 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 connettore che possono essere usati per limitare il risultato a Electric Vehicle Station che supporta tipi di connettore specifici. L'ordine degli elementi non è importante. Quando vengono forniti più tipi di connettore, verranno restituiti solo i risultati che appartengono a (almeno) uno degli elenchi specificati.
I tipi di connettore disponibili sono:
-
StandardHouseholdCountrySpecific
- Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard. Vedere anche: Collegare & tipi di socket - Standard mondiali. -
IEC62196Type1
- Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase. -
IEC62196Type1CCS
- Connettore combinato basato su 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 (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio. -
IEC62196Type2CableAttached
- Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica. -
IEC62196Type2Outlet
- Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica. -
IEC62196Type2CCS
- Connettore combinato basato su 2 tipo, 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 (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio. -
IEC62196Type3
- Tipo 3 connettore definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi. -
Chademo
- Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce. -
IEC60309AC1PhaseBlue
- Connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di 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 Bianco industriale è un connettore DC definito nello standard IEC 60309. -
Tesla
- Il connettore Tesla è il connettore Tesla Supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa.
Esempi di utilizzo:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Nome | Tipo | Descrizione |
---|---|---|
Chademo |
string |
Connettore CHAdeMO denominato dopo un'associazione formata dalla Tokyo Electric Power Company e dai partner industriali. A causa di questo è noto anche come connettore DI TEPCO. Supporta la ricarica a controller di dominio veloce. |
IEC60309AC1PhaseBlue |
string |
Il connettore Industrial Blue è un connettore definito nello standard IEC 60309. Si tratta di un'ora definita da una combinazione di standard, il colore e il fatto che è un connettore a fase singola. Il connettore ha in genere la configurazione "P+N+E, 6h". |
IEC60309DCWhite |
string |
Il connettore Bianco industriale è un connettore DC definito nello standard IEC 60309. |
IEC62196Type1 |
string |
Connettore di tipo 1 definito nello standard IEC 62196-2. Chiamato anche Yazaki dopo il produttore originale o SAE J1772 dopo lo standard che l'ha prima pubblicata. Principalmente usato in combinazione con una singola fase 120V o fino a 240V infrastruttura a singola fase. |
IEC62196Type1CCS |
string |
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 (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio. |
IEC62196Type2CCS |
string |
Connettore combinato basato su 2 tipo, 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 (Direct Current) aggiuntivi per consentire la ricarica rapida del controller di dominio. |
IEC62196Type2CableAttached |
string |
Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come cavo e collegamento al punto di ricarica |
IEC62196Type2Outlet |
string |
Connettore di tipo 2 definito nello standard IEC 62196-2. Fornito come socket impostato nel punto di ricarica. |
IEC62196Type3 |
string |
Connettore di tipo 3 definito nello standard IEC 62196-2. Chiamato anche Truffa dopo il produttore originale. Principalmente usato in combinazione con una singola fase fino a 240V o fino a 420V infrastruttura a tre fasi. |
StandardHouseholdCountrySpecific |
string |
Questi sono i connettori domestici standard per una determinata area. Sono tutte singole fasi ac e la tensione standard e l'amperage standard. Vedere anche: Plug & socket type - World Standards |
Tesla |
string |
Il connettore Tesla è il connettore Tesla supercharger specifico a livello regionale. Ad esempio, si riferisce al connettore proprietario di Tesla, talvolta noto come Porta Tesla principalmente limitato a America del Nord o al tipo modificato 2 (DC over Type 2) in Europa. |
Entity
Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa, questa operazione è sempre uguale alla posizione.
Nome | Tipo | Descrizione |
---|---|---|
position |
string |
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 secondario. |
EntryPointType
Tipo di punto di ingresso. Il valore può essere principale o secondario.
Nome | Tipo | Descrizione |
---|---|---|
main |
string |
|
minor |
string |
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.
Nome | Tipo | Descrizione |
---|---|---|
Country |
string |
nome paese/area geografica |
CountrySecondarySubdivision |
string |
Contea |
CountrySubdivision |
string |
State or Province |
CountryTertiarySubdivision |
string |
Area denominata |
Municipality |
string |
Città/Città |
MunicipalitySubdivision |
string |
Sub/Super City |
Neighbourhood |
string |
Quartiere |
PostalCodeArea |
string |
Codice postale/codice postale |
Geometry
Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Passarlo come geometryId all'API Get Search Polygon per recuperare le informazioni di geometria per questo risultato. |
LatLongPairAbbreviated
Una posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
Nome | Tipo | Descrizione |
---|---|---|
lat |
number |
Latitudine, proprietà |
lon |
number |
Proprietà Longitudine |
LocalizedMapView
Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.
Per informazioni dettagliate, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.
Nome | Tipo | Descrizione |
---|---|---|
AE |
string |
Emirati Arabi Uniti (visualizzazione araba) |
AR |
string |
Argentina (visualizzazione argentina) |
Auto |
string |
Restituisce i dati della mappa in base all'indirizzo IP della richiesta. |
BH |
string |
Bahrain (visualizzazione araba) |
IN |
string |
India (visualizzazione indiana) |
IQ |
string |
Iraq (visualizzazione araba) |
JO |
string |
Giordania (visualizzazione araba) |
KW |
string |
Kuwait (visualizzazione araba) |
LB |
string |
Libano (visualizzazione araba) |
MA |
string |
Marocco (visualizzazione marocchina) |
OM |
string |
Oman (visualizzazione araba) |
PK |
string |
Pakistan (visualizzazione pakistana) |
PS |
string |
Autorità Palestinese (visualizzazione araba) |
QA |
string |
Qatar (visualizzazione araba) |
SA |
string |
Arabia Saudita (visualizzazione araba) |
SY |
string |
Siria (visualizzazione araba) |
Unified |
string |
Visualizzazione unificata (altri) |
YE |
string |
Yemen (visualizzazione araba) |
MatchType
Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.
Nome | Tipo | Descrizione |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Orari 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 operazione per un punto di interesse (punti di interesse). La disponibilità delle ore di operazione varia in base ai dati disponibili. In caso contrario, non verranno restituite informazioni sulle ore di apertura. Valore supportato: nextSevenDays
Nome | Tipo | Descrizione |
---|---|---|
nextSevenDays |
string |
Mostra le ore dell'operazione per la prossima settimana, a partire dal giorno corrente nell'ora locale dell'istanza di POI. |
OperatingHoursTime
Rappresenta una data e un'ora
Nome | Tipo | Descrizione |
---|---|---|
date |
string |
Rappresenta la data del calendario corrente nel fuso orario di calendario, ad esempio "2019-02-07". |
hour |
integer |
Le ore sono nel formato di 24 ore nell'ora locale di un punto di interesse; i valori possibili sono 0 - 23. |
minute |
integer |
I minuti sono nell'ora locale di un punto di interesse; I valori possibili sono compresi tra 0 e 59. |
OperatingHoursTimeRange
Intervallo di tempo aperto per un giorno
Nome | Tipo | Descrizione |
---|---|---|
endTime |
Punto nell'intervallo di 7 giorni successivo in cui viene chiuso un punto di interesse specificato o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo. |
|
startTime |
Punto nell'intervallo di 7 giorni successivo in cui viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo. |
PointOfInterest
Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.
Nome | Tipo | Descrizione |
---|---|---|
brands |
Brand[] |
Matrice marchi. Nome del marchio per il punto di interesse restituito. |
categories |
string[] |
Matrice categorie |
categorySet |
Elenco delle categorie più specifiche di POI |
|
classifications |
Matrice di classificazione |
|
name |
string |
Nome della proprietà POI |
openingHours |
Orari di apertura per un punto di interesse (Punti di interesse). |
|
phone |
string |
Proprietà Numero di telefono |
url |
string |
Proprietà URL sito Web |
PointOfInterestCategorySet
Categoria di punti di interesse
Nome | Tipo | Descrizione |
---|---|---|
id |
integer |
ID della categoria |
QueryType
Tipo di query restituito: NEARBY o NON_NEAR.
Nome | Tipo | Descrizione |
---|---|---|
NEARBY |
string |
Search è stato eseguito intorno a una determinata latitudine e longitudine con un raggio definito |
NON_NEAR |
string |
Search è stata eseguita a livello globale, senza pregiudizi a una determinata latitudine e longitudine, e nessun raggio definito |
ResponseFormat
Formato desiderato della risposta. Il valore può essere json o xml.
Nome | Tipo | Descrizione |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
Questo oggetto viene restituito da una chiamata di Search riuscita.
Nome | Tipo | Descrizione |
---|---|---|
results |
Elenco dei risultati dell'API Search. |
|
summary |
Oggetto Riepilogo per una risposta API di Search |
SearchAddressResultItem
Oggetto Result per una risposta API Search.
Nome | Tipo | Descrizione |
---|---|---|
address |
Indirizzo del risultato |
|
addressRanges |
Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse. |
|
dataSources |
Sezione facoltativa. ID geometry di riferimento per l'uso con l'API Get Search Polygon. |
|
detourTime |
integer |
Detour time in secondi. Restituito solo per le chiamate all'API Search Lungo route. |
dist |
number |
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. Tali informazioni descrivono i tipi di ingresso 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 indietro. |
|
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 valori possibili:
|
|
poi |
Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni. |
|
position |
Una posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
score |
number |
Valore all'interno di un set di risultati per indicare il punteggio di corrispondenza relativo tra i risultati. È possibile usare questa operazione per determinare che il risultato x è due volte più probabile che sia rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra query e sono destinati solo a un valore relativo per un set di risultati. |
type |
Uno dei valori possibili:
|
|
viewport |
Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione. |
SearchAddressResultType
Uno dei valori possibili:
- POI
- Indirizzo
- Area geografica
- Punto di interesse
- Intervallo di indirizzi
- Incrocio
Nome | Tipo | Descrizione |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
Indici per i quali i codici postali estesi devono essere inclusi nei risultati.
Gli indici disponibili sono:
Addr = Intervalli di indirizzi
Geo = Aree geografiche
PAD = Indirizzi del punto
POI = Punti di interesse
Str = Strade
XStr = Cross Street (intersezioni)
Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuno per nessun indice.
Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto devono essere richiesti in modo esplicito quando necessario.
Esempi di utilizzo:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD, Addr,POI
extendedPostalCodesFor=None
Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.
Nome | Tipo | Descrizione |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchSummary
Oggetto Riepilogo per una risposta API Search.
Nome | Tipo | Descrizione |
---|---|---|
fuzzyLevel |
integer |
Il livello massimo di fuzzy richiesto per fornire risultati. |
geoBias |
Indicazione quando il motore di ricerca interno ha applicato un pregiudizio geospaziale per migliorare la classificazione dei risultati. In alcuni metodi questo può essere interessato impostando i parametri lat e lon in cui sono disponibili. In altri casi è puramente interna. |
|
limit |
integer |
Numero massimo di risposte che verranno restituite |
numResults |
integer |
Numero di risultati nella risposta. |
offset |
integer |
Offset iniziale dei risultati restituiti all'interno del set di risultati completo. |
query |
string |
Parametro di query usato per produrre questi risultati della ricerca. |
queryTime |
integer |
Tempo trascorso per la risoluzione della query, in millisecondi. |
queryType |
Tipo di query restituito: NEARBY o NON_NEAR. |
|
totalResults |
integer |
Numero totale di risultati trovati. |