Traffic - Get Traffic Incident Viewport
Usare per ottenere informazioni legali e tecniche per un viewport.
L'API Traffic Incident Viewport
è una richiesta HTTP GET
che restituisce informazioni legali e tecniche per il viewport descritto nella richiesta. Deve essere chiamato dalle applicazioni client ogni volta che il riquadro di visualizzazione cambia , ad esempio tramite zoom, panoramica, andando a una posizione o visualizzando una route. La richiesta deve contenere il rettangolo di selezione e il livello di zoom del viewport le cui informazioni sono necessarie. Il restituito conterrà informazioni sulla versione mappa, nonché l'ID modello di traffico corrente e gli ID copyright. L'ID del modello di traffico restituito dalla descrizione viewport viene usato da altre API per recuperare le ultime informazioni sul traffico per un'ulteriore elaborazione.
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}©right={copyright}
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. |
boundingbox
|
query | True |
number[] |
Casella di selezione del riquadro di visualizzazione mappa nella EPSG900913 proiezione. L'oggetto |
boundingzoom
|
query | True |
integer int32 |
Livello di zoom del riquadro di visualizzazione mappa. Usato per determinare se la visualizzazione può essere ingrandita. |
overviewbox
|
query | True |
number[] |
Casella di selezione della mappa panoramica nella EPSG900913 proiezione. |
overviewzoom
|
query | True |
integer int32 |
Livello di zoom della mappa panoramica. Se non esiste alcuna mappa mini, usare lo stesso livello di zoom del limiteZoom. |
copyright
|
query |
boolean |
Determina le informazioni sul copyright da restituire. Quando viene restituito il testo del copyright; quando viene restituito solo false l'indice di copyright. |
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 la sicurezza di Microsoft Entra ID 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 di Microsoft Entra OAuth 2.0 . Quando è associato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure 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 le API REST di Mappe di Azure.
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.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare la risorsa mappe di Azure 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 dispongono di URL di autorizzazione univoci e configurazioni di 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 di Azure Maps 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 eseguito 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 delle 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 nella risorsa mappe 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 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
Request traffic incident information for the selected viewport
Esempio di richiesta
GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2©right=True
Risposta di esempio
{
"viewpResp": {
"trafficState": {
"@trafficAge": 18895,
"@trafficModelId": "1504808593298"
},
"copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis",
"@version": "1.0.51-mascoma",
"@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Informazioni aggiuntive sulla gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Response |
Formato desiderato della risposta. Il valore può essere json o xml. |
Traffic |
Questo oggetto viene restituito da una chiamata di Visualizzazione eventi imprevisti del traffico riuscita |
Traffic |
Informazioni sullo stato del traffico |
Viewp |
Oggetto Viewport Response |
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 |
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. |
ResponseFormat
Formato desiderato della risposta. Il valore può essere json o xml.
Nome | Tipo | Descrizione |
---|---|---|
json |
string |
|
xml |
string |
TrafficIncidentViewport
Questo oggetto viene restituito da una chiamata di Visualizzazione eventi imprevisti del traffico riuscita
Nome | Tipo | Descrizione |
---|---|---|
viewpResp |
Oggetto Viewport Response |
TrafficState
Informazioni sullo stato del traffico
Nome | Tipo | Descrizione |
---|---|---|
@trafficAge |
integer |
Tempo trascorso (in secondi) dalla creazione dell'ID modello di traffico. |
@trafficModelId |
string |
L'ID univoco denominato ID modello di traffico viene usato nelle chiamate ai servizi eventi imprevisti del traffico. Consente di ottenere informazioni da specifici aggiornamenti del traffico. L'ID modello di traffico viene aggiornato ogni minuto ed è valido per due minuti prima del timeout. |
ViewpResp
Oggetto Viewport Response
Nome | Tipo | Descrizione |
---|---|---|
@maps |
string |
Indica i nomi interni del provider di dati per i dati della mappa usati nel viewport. Per l'uso con le query di supporto. |
@version |
string |
Indica la versione del software usata per generare le informazioni. Per l'uso con le query di supporto. |
copyrightIds |
string |
Quando il valore del parametro copyright è true, contiene il testo completo delle informazioni sul copyright che devono essere visualizzate con i riquadri nel viewport |
trafficState |
Informazioni sullo stato del traffico |