Traffic - Get Traffic Flow Segment

Riferimento

Servizio:: Maps

Versione API:: 1.0

Utilizzare per ottenere informazioni sulle velocità e sui tempi di viaggio della sezione di strada specificata.

L'API Traffic Flow Segment è una richiesta http GET che fornisce informazioni sulle velocità e sui tempi di viaggio del frammento di strada più vicino alle coordinate specificate. È progettato per funzionare insieme al livello Flow del Render Service per supportare visualizzazioni dei dati di flusso selezionabili. Con l'API Traffic Flow Segment, il lato client può connettere qualsiasi posizione della mappa con i dati del flusso sulla strada più vicina e presentarli all'utente.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

Con parametri facoltativi:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

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.
query	query	True	number[]	Coordinate del punto vicino al segmento di strada. Questo parametro è un elenco di quattro coordinate, contenente due coppie di coordinate (lat, long, lat, long) e calcolate usando EPSG4326 proiezione. Quando questo endpoint viene chiamato direttamente, le coordinate vengono passate come una singola stringa contenente quattro coordinate, separate da virgole.
style	query	True	TrafficFlowSegmentStyle	Stile da utilizzare per eseguire il rendering del riquadro. I valori validi sono assoluti che restituiscono i colori che riflettono la velocità assoluta misurata, relativa che restituisce la velocità rispetto al flusso libero, il ritardo relativo che visualizza velocità relative solo in cui sono diverse dalla velocità del flusso libero
zoom	query	True	integer (int32)	Livello di zoom per il riquadro desiderato. Il valore di zoom deve essere compreso nell'intervallo: 0-22 (incluso). Per informazioni dettagliate, vedere Livelli di zoom e griglia riquadri.
openLr	query		boolean	Valore booleano se la risposta deve includere il codice OpenLR
thickness	query		integer (int32) minimum: 1 maximum: 20	Valore della larghezza della linea che rappresenta il traffico. Questo valore è un moltiplicatore e i valori accettati sono compresi tra 1 e 20. Il valore predefinito è 10.
unit	query		SpeedUnit	Unità di velocità in KMPH o MPH

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	TrafficFlowSegmentData	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 flow segment information

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Risposta di esempio

Codice di stato:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

Definizioni

Nome	Descrizione
Coordinates	Include le coordinate che descrivono la forma del segmento. Le coordinate vengono spostate dalla strada a seconda del livello di zoom per supportare la visualizzazione di alta qualità in ogni scala.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FlowSegmentData	Proprietà Flow Segment Data
LatLongPair	Posizione rappresentata come latitudine e longitudine.
ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
SpeedUnit	Unità di velocità in KMPH o MPH
TrafficFlowSegmentData	Questo oggetto viene restituito da una chiamata di segmento del flusso di traffico riuscita
TrafficFlowSegmentStyle	Stile da utilizzare per eseguire il rendering del riquadro. I valori validi sono assoluti che restituiscono i colori che riflettono la velocità assoluta misurata, relativa che restituisce la velocità rispetto al flusso libero, il ritardo relativo che visualizza velocità relative solo in cui sono diverse dalla velocità del flusso libero

Coordinates

Object

Include le coordinate che descrivono la forma del segmento. Le coordinate vengono spostate dalla strada a seconda del livello di zoom per supportare la visualizzazione di alta qualità in ogni scala.

Nome	Tipo	Descrizione
coordinate	LatLongPair[]	Matrice di coordinate

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.

FlowSegmentData

Object

Proprietà Flow Segment Data

Nome	Tipo	Descrizione
@version	string	Indica la versione software che ha generato la risposta.
confidence	number	La fiducia è una misura della qualità del tempo di viaggio e della velocità forniti. Il valore 1 indica l'attendibilità totale, che la risposta contiene i dati di qualità più elevati. I valori inferiori indicano il grado che la risposta può variare dalle condizioni effettive sulla strada. Qualsiasi valore maggiore di 0,6 indica che le informazioni sono basate sull'input del probe in tempo reale. Il valore 0,5 indica che la velocità segnalata è basata su informazioni cronologiche. Un valore compreso tra 0,5 e 0,6 ha una media calcolata ponderata tra velocità cronologiche e in tempo reale.
coordinates	Coordinates	Include le coordinate che descrivono la forma del segmento. Le coordinate vengono spostate dalla strada a seconda del livello di zoom per supportare la visualizzazione di alta qualità in ogni scala.
currentSpeed	integer (int32)	Velocità media corrente in corrispondenza del punto selezionato, nelle unità richieste. Questa operazione viene calcolata in base all'oggetto currentGuideTime e alla lunghezza del segmento selezionato.
currentTravelTime	integer (int32)	Tempo di viaggio corrente in secondi, in questo segmento di traffico, in base alle misurazioni in tempo reale fuse tra le posizioni definite nella direzione specificata.
frc	string	Classe road funzionale. Questo indica il tipo di strada: 0: autostrada, autostrada o altra strada principale. 1: Strada principale, meno importante di un'autostrada. 2: Altra strada principale. 3: Strada secondaria. 4: Strada di collegamento locale. 5: Strada locale di alta importanza. 6: Strada locale.
freeFlowSpeed	integer (int32)	La velocità del flusso libero prevista in condizioni ideali, espresse nelle unità richieste. Questa operazione è correlata a freeFlowFlowFlowTime.
freeFlowTravelTime	integer (int32)	Tempo di viaggio in secondi, in questo segmento di traffico, che sarebbe previsto in condizioni di flusso libero ideali.
openlr	string	Codice OpenLR per segmento. Per altre informazioni sull'uso dei codici Open LR, vedere OpenLR.

LatLongPair

Object

Posizione rappresentata come latitudine e longitudine.

Nome	Tipo	Descrizione
latitude	number (double)	Proprietà Latitude
longitude	number (double)	Longitudine - proprietà

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

SpeedUnit

Enumerazione

Unità di velocità in KMPH o MPH

Valore	Descrizione
KMPH	Chilometri all'ora
MPH	Miglia all'ora

TrafficFlowSegmentData

Object

Questo oggetto viene restituito da una chiamata di segmento del flusso di traffico riuscita

Nome	Tipo	Descrizione
flowSegmentData	FlowSegmentData	Proprietà Flow Segment Data

TrafficFlowSegmentStyle

Enumerazione

Stile da utilizzare per eseguire il rendering del riquadro. I valori validi sono assoluti che restituiscono i colori che riflettono la velocità assoluta misurata, relativa che restituisce la velocità rispetto al flusso libero, il ritardo relativo che visualizza velocità relative solo in cui sono diverse dalla velocità del flusso libero

Valore	Descrizione
absolute
relative
relative-delay

Condividi tramite

Traffic - Get Traffic Flow Segment

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Note

Ambiti

subscription-key

SAS Token

Esempio

Request traffic flow segment information

Esempio di richiesta

Risposta di esempio

Definizioni

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle

Risorse aggiuntive