Traffic - Get Traffic Incident Viewport

Riferimento

Servizio:: Maps

Versione API:: 1.0

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, passando a una posizione o visualizzando una route). La richiesta deve contenere il riquadro delimitatore e il livello di zoom del riquadro di visualizzazione le cui informazioni sono necessarie. Il valore restituito conterrà le informazioni sulla versione della mappa, nonché l'ID modello di traffico e gli ID copyright correnti. L'ID del modello di traffico restituito dalla descrizione del viewport viene usato da altre API per recuperare le informazioni sull'ultimo 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}

Con parametri facoltativi:

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	ResponseFormat	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[]	Rettangolo di selezione del riquadro di visualizzazione mappa nella proiezione EPSG900913. Il `boundingbox` è rappresentato da due coppie di valori che descrivono gli angoli (prima coppia per angolo inferiore sinistro e seconda per in alto a destra). Quando questo endpoint viene chiamato direttamente, tutti i valori devono essere separati da virgole (ad esempio, minY,minX,maxY,maxX). La dimensione massima del rettangolo di selezione che può essere passata dipende dal livello di zoom richiesto. La larghezza e l'altezza non possono superare i 4092 pixel quando ne viene eseguito il rendering sul livello di zoom specificato. NOTA: i rettangoli di delimitazione che attraversano il meridiano di 180° richiedono un trattamento speciale. Per tali scatole, il valore maxX orientale sarà negativo e quindi meno del valore minX a ovest del meridiano a 180°. Per risolvere questo errore, è necessario aggiungere il valore 40075016.6855874 al valore true maxX prima che venga passato nella richiesta.
boundingzoom	query	True	integer (int32) minimum: 0 maximum: 22	Livello di zoom del viewport mappa. Consente di determinare se la visualizzazione può essere ingrandita.
overviewbox	query	True	number[]	Rettangolo di selezione della mappa di panoramica nella EPSG900913 proiezione. Usato nel caso in cui la casella di panoramica/mini mappa abbia dati di copyright diversi rispetto alla mappa principale. Se non è presente alcuna mappa minima, vengono utilizzate le stesse coordinate di `boundingBox`. Quando questo endpoint viene chiamato direttamente, le coordinate vengono passate come una singola stringa contenente quattro coordinate, separate da virgole.
overviewzoom	query	True	integer (int32) minimum: 0 maximum: 22	Livello di zoom della mappa di panoramica. Se non è presente una mini mappa, usare lo stesso livello di zoom del boundingZoom.
copyright	query		boolean	Determina le informazioni sul copyright da restituire. Se true, viene restituito il testo del copyright; quando viene restituito false solo l'indice di copyright.

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	TrafficIncidentViewport	Va bene
Other Status Codes	ErrorResponse	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.

Note

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 del 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

Request traffic incident information for the selected viewport

Esempio di richiesta

HTTP

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&copyright=True

Risposta di esempio

Codice di stato:: 200

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 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
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
TrafficIncidentViewport	Questo oggetto viene restituito da una chiamata di Visualizzazione eventi imprevisti del traffico riuscita
TrafficState	Informazioni sullo stato del traffico
ViewpResp	Oggetto Response viewport

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

Object

Dettagli dell'errore.

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

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ResponseFormat

Enumerazione

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

TrafficIncidentViewport

Object

Questo oggetto viene restituito da una chiamata di Visualizzazione eventi imprevisti del traffico riuscita

Nome	Tipo	Descrizione
viewpResp	ViewpResp	Oggetto Response viewport

TrafficState

Object

Informazioni sullo stato del traffico

Nome	Tipo	Descrizione
@trafficAge	integer (int32)	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

Object

Oggetto Response viewport

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 utilizzata 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	TrafficState	Informazioni sullo stato del traffico

Condividi tramite

Traffic - Get Traffic Incident Viewport

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Note

Ambiti

subscription-key

SAS Token

Esempio

Request traffic incident information for the selected viewport

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResponseFormat

TrafficIncidentViewport

TrafficState

ViewpResp