Condividi tramite

Route - Post Route Directions Batch Sync

  • Riferimento
Servizio:
Maps
Versione API:
1.0

Usare per inviare un batch di query all'API Get Route Directions in una singola richiesta sincrona.

L'API è una richiesta HTTP POST che invia batch di query all'API Post Route Directions Batch SyncGet Route Directions usando una singola richiesta sincrona. È possibile chiamare Route Directions Batch l'API per eseguire in modo asincrono (asincrono) o in modo sincrono (sincronizzazione). L'API asincrona consente al chiamante di eseguire il batch fino a 700 query e sincronizzare l'API fino a 100 query. Per chiamare l'API Post Route Directions Batch in una richiesta asincrona, vedere Post Route Directions Batch.

Invia richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modello di risposta batch

Il contenuto dei dati restituito è simile alle richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha completato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un summary componente che indica la totalRequests parte della richiesta batch originale e successfulRequests, ad esempio, le query eseguite correttamente. La risposta batch include anche una matrice che contiene una batchItems risposta per ogni query e ogni query nella richiesta batch. Conterrà batchItems i risultati nello stesso ordine di invio delle query originali nella richiesta batch. Ogni elemento in batchItems contiene statusCode e response campi. Ognuno response di essi batchItems è di uno dei tipi seguenti:

  • RouteDirections - Se la query è stata completata correttamente.

  • Error - Se la query non è riuscita. La risposta conterrà un code oggetto e in message questo caso.

Ecco un esempio di Risposta batch con esito positivo e 1 risultato non riuscito :

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

Parametri dell'URI

Nome In Necessario Tipo Descrizione
format
 path True

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.
api-version
 query True

string

Numero di versione dell'API Mappe di Azure.

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 di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Corpo della richiesta

Nome Tipo Descrizione
batchItems

BatchRequestItem[]

Elenco di query da elaborare.

Risposte

Nome Tipo Descrizione
200 OK

RouteDirectionsBatchResult

OK
Other Status Codes

ErrorResponse

Timeout: la richiesta ha richiesto più tempo rispetto alla quantità massima di tempo definita nell'API.
Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato 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 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 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.

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 mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra. * 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.

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

Successfully retrieve the route direction batch result synchronously

Esempio di richiesta

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}
Codice di stato:
408 
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definizioni

Nome Descrizione
BatchRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Batch.
BatchRequestItem

Oggetto richiesta batch
DelayMagnitude

La grandezza del ritardo causato dall'incidente. Questi valori corrispondono ai valori del campo di risposta ty dell'API Get Traffic Incident Detail.
DrivingSide

Indica la guida laterale sinistra e quella destra al punto della manovra.
EffectiveSetting

Parametro o dati effettivi usati quando si chiama questa API di route.
ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
GuidanceInstructionType

Tipo di istruzione, ad esempio turno o modifica della forma stradale.
GuidanceManeuver

Codice che identifica la manovra.
JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.
JunctionType

Tipo di giunzione in cui si svolge la manovra. Per i più grandi spazi, vengono generate due istruzioni separate per l'ingresso e l'uscita dalla rotatoria.
LatLongPair

Una posizione rappresentata come latitudine e longitudine.
Response

Risultato della query. RouteDirections se la query è stata completata correttamente, ErrorResponse in caso contrario.
ResponseSectionType

Tipi di sezione della risposta di route segnalata
ResponseTravelMode

Modalità di viaggio per il percorso calcolato. Il valore verrà impostato su other se la modalità richiesta di trasporto non è possibile in questa sezione
Route
RouteDirectionsBatchItem

Elemento restituito dalla chiamata al servizio Route Directions Batch.
RouteDirectionsBatchResult

Questo oggetto viene restituito da una chiamata al servizio Route Directions Batch riuscita.
RouteGuidance

Contiene elementi correlati alle linee guida. Questo campo è presente solo quando sono state richieste indicazioni ed è disponibile.
RouteInstruction

Set di attributi che descrivono una manovra, ad esempio 'Gira a destra', 'Mantieni a sinistra', 'Prendi il traghetto', 'Prendi l'autostrada', 'Arriva'.
RouteInstructionGroup

Raggruppa una sequenza di elementi di istruzione correlati tra loro. L'intervallo di sequenze è vincolato con firstInstructionIndex e lastInstructionIndex. Quando vengono richiesti messaggi di testo leggibili per istruzioni (instructionType=text o tagged), il gruppo di istruzioni include un messaggio di riepilogo restituito quando disponibile.
RouteLeg

Descrizione di una parte di una route, costituita da un elenco di punti. Ogni punto di modo aggiuntivo fornito nella richiesta comporterà una gamba aggiuntiva nel percorso restituito.
RouteLegSummary

Oggetto Riepilogo per la sezione route.
RouteOptimizedWaypoint

Oggetto punto di modo ottimizzato.
RouteReport

Segnala le impostazioni effettive usate nella chiamata corrente.
RouteSection

Le sezioni di route contengono informazioni aggiuntive sulle parti di una route. Ogni sezione contiene almeno gli elementi startPointIndex, endPointIndexe sectionType.
RouteSectionTec

Dettagli dell'evento di traffico, usando le definizioni nello standard TPEG2-TEC . Può contenere effectCode e causare elementi.
RouteSectionTecCause

Causa dell'evento di traffico. Può contenere elementi mainCauseCode e subCauseCode. Può essere usato per definire iconografia e descrizioni.
RouteSummary

Oggetto Riepilogo
SimpleCategory

Tipo dell'evento imprevisto. Attualmente può essere JAM, ROAD_WORK, ROAD_CLOSURE o OTHER. Per informazioni dettagliate, vedere "tec".
Summary

Riepilogo dei risultati della richiesta batch

BatchRequest

Questo tipo rappresenta il corpo della richiesta per il servizio Batch.

Nome Tipo Descrizione
batchItems

BatchRequestItem[]

Elenco delle query da elaborare.

BatchRequestItem

Oggetto richiesta batch

Nome Tipo Descrizione
query

string

Questo parametro contiene una stringa di query usata per eseguire un'operazione di geocodificazione non strutturata. La stringa di query verrà passata verbatim all'API di ricerca per l'elaborazione.

DelayMagnitude

La grandezza del ritardo causato dall'incidente. Questi valori corrispondono ai valori del campo di risposta ty dell'API Get Traffic Incident Detail.

Nome Tipo Descrizione
0

string

Sconosciuto.
1

string

Secondaria.
2

string

Moderato.
3

string

Principale
4

string

Non definito, usato per le chiusura stradali e altri ritardi indefiniti.

DrivingSide

Indica la guida laterale sinistra e quella destra al punto della manovra.

Nome Tipo Descrizione
LEFT

string

A sinistra.
RIGHT

string

Destra.

EffectiveSetting

Parametro o dati effettivi usati quando si chiama questa API di route.

Nome Tipo Descrizione
key

string

Nome del parametro usato.
value

string

Valore del parametro usato.

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

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

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

GuidanceInstructionType

Tipo di istruzione, ad esempio turno o modifica della forma stradale.

Nome Tipo Descrizione
DIRECTION_INFO

string

Informazioni sulla direzione.
LOCATION_ARRIVAL

string

Posizione di arrivo.
LOCATION_DEPARTURE

string

Posizione di partenza.
LOCATION_WAYPOINT

string

Posizione del punto di percorso.
ROAD_CHANGE

string

Cambio di strada.
TURN

string

Girare.

GuidanceManeuver

Codice che identifica la manovra.

Nome Tipo Descrizione
ARRIVE

string

Sei arrivato.
ARRIVE_LEFT

string

Sei arrivato. La destinazione è a sinistra.
ARRIVE_RIGHT

string

Sei arrivato. La destinazione è a destra.
BEAR_LEFT

string

Orso a sinistra.
BEAR_RIGHT

string

Porta destra.
DEPART

string

Partire.
ENTER_FREEWAY

string

Prendi la strada libera.
ENTER_HIGHWAY

string

Prendi l'autostrada.
ENTER_MOTORWAY

string

Prendi l'autostrada.
ENTRANCE_RAMP

string

Prendi la rampa.
FOLLOW

string

Seguire.
KEEP_LEFT

string

Tieni a sinistra.
KEEP_RIGHT

string

Continuate bene.
MAKE_UTURN

string

Fare un turno U.
MOTORWAY_EXIT_LEFT

string

Prendi l'uscita sinistra.
MOTORWAY_EXIT_RIGHT

string

Prendi l'uscita destra.
ROUNDABOUT_BACK

string

Andate in giro per la rotonda.
ROUNDABOUT_CROSS

string

Attraversare la rotatoria.
ROUNDABOUT_LEFT

string

Alla rotonda prendere l'uscita a sinistra.
ROUNDABOUT_RIGHT

string

Alla rotonda prendere l'uscita a destra.
SHARP_LEFT

string

Gira a sinistra affilata.
SHARP_RIGHT

string

Gira a destra affilata.
STRAIGHT

string

Continuate dritto.
SWITCH_MAIN_ROAD

string

Passare alla strada principale.
SWITCH_PARALLEL_ROAD

string

Passare alla strada parallela.
TAKE_EXIT

string

Prendi l'uscita.
TAKE_FERRY

string

Prendi il traghetto.
TRY_MAKE_UTURN

string

Prova a fare un turno U.
TURN_LEFT

string

Gira a sinistra.
TURN_RIGHT

string

Gira a destra.
WAYPOINT_LEFT

string

Hai raggiunto il punto di arrivo. È a sinistra.
WAYPOINT_REACHED

string

Hai raggiunto il punto di arrivo.
WAYPOINT_RIGHT

string

Hai raggiunto il punto di arrivo. È sulla destra.

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

Nome Tipo Descrizione
json

string

Formato di interscambio dati dell'oggetto JavaScript

JunctionType

Tipo di giunzione in cui si svolge la manovra. Per i più grandi spazi, vengono generate due istruzioni separate per l'ingresso e l'uscita dalla rotatoria.

Nome Tipo Descrizione
BIFURCATION

string

biforcazione
REGULAR

string

normale
ROUNDABOUT

string

rotonda

LatLongPair

Una posizione rappresentata come latitudine e longitudine.

Nome Tipo Descrizione
latitude

number

Latitudine, proprietà
longitude

number

Proprietà Longitudine

Response

Risultato della query. RouteDirections se la query è stata completata correttamente, ErrorResponse in caso contrario.

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.
formatVersion

string

Format Version, proprietà
optimizedWaypoints

RouteOptimizedWaypoint[]

Sequenza ottimizzata di punti di modo. Mostra l'indice dall'utente fornito sequenza di waypoint per l'elenco originale e ottimizzato. Ad esempio, una risposta:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

significa che la sequenza originale è [0, 1, 2] e la sequenza ottimizzata è [1, 2, 0]. Poiché l'indice inizia per 0 l'originale è "primo, secondo, terzo" mentre l'indice ottimizzato è "secondo, terzo, primo".
report

RouteReport

Segnala le impostazioni effettive usate nella chiamata corrente.
routes

Route[]

Matrice di route

ResponseSectionType

Tipi di sezione della risposta di route segnalata

Nome Tipo Descrizione
CARPOOL

string

Sezioni del percorso che richiedono l'uso di carpool (HOV/High Occupancy Vehicle) corsie.
CAR_TRAIN

string

Sezioni del percorso che sono auto o treni.
COUNTRY

string

Sezioni che indicano i paesi/aree geografiche in cui si trova la route.
FERRY

string

Sezioni del percorso che sono traghetti.
MOTORWAY

string

Sezioni del percorso che sono autostrade.
PEDESTRIAN

string

Sezioni del percorso che sono adatte solo per i pedonali.
TOLL_ROAD

string

Sezioni del percorso che richiedono il pagamento di un pedaggio.
TOLL_VIGNETTE

string

Sezioni del percorso che richiedono che sia presente una vignetta a pedaggio.
TRAFFIC

string

Sezioni della route che contengono informazioni sul traffico.
TRAVEL_MODE

string

Sezioni in relazione al parametro travelModedella richiesta .
TUNNEL

string

Sezioni della route che sono tunnel.
URBAN

string

Sezioni del percorso che si trovano all'interno di aree urbane.

ResponseTravelMode

Modalità di viaggio per il percorso calcolato. Il valore verrà impostato su other se la modalità richiesta di trasporto non è possibile in questa sezione

Nome Tipo Descrizione
bicycle

string

I percorsi restituiti sono ottimizzati per le biciclette, incluso l'uso di corsie di bicicletta.
bus

string

I percorsi restituiti sono ottimizzati per gli autobus, incluso l'uso di solo corsie di autobus. Funzionalità BETA.
car

string

I percorsi restituiti sono ottimizzati per le automobili.
motorcycle

string

Le route restituite sono ottimizzate per le moto. Funzionalità BETA.
other

string

La modalità di trasporto specificata non è possibile in questa sezione
pedestrian

string

I percorsi restituiti sono ottimizzati per i pedonali, tra cui l'uso di marciapiedi.
taxi

string

Le route restituite sono ottimizzate per i taxi. Funzionalità BETA.
truck

string

I percorsi restituiti sono ottimizzati per i veicoli commerciali, come per i camion.
van

string

Le route restituite sono ottimizzate per i furgoni. Funzionalità BETA.

Route

Nome Tipo Descrizione
guidance

RouteGuidance

Contiene elementi correlati alle linee guida. Questo campo è presente solo quando sono state richieste indicazioni ed è disponibile.
legs

RouteLeg[]

Matrice gambe
sections

RouteSection[]

Matrice di sezioni
summary

RouteSummary

Oggetto Riepilogo

RouteDirectionsBatchItem

Elemento restituito dalla chiamata al servizio Route Directions Batch.

Nome Tipo Descrizione
response

Response

Risultato della query. RouteDirections se la query è stata completata correttamente, ErrorResponse in caso contrario.
statusCode

integer

Codice di stato della richiesta HTTP.

RouteDirectionsBatchResult

Questo oggetto viene restituito da una chiamata al servizio Route Directions Batch riuscita.

Nome Tipo Descrizione
batchItems

RouteDirectionsBatchItem[]

Matrice contenente i risultati del batch.
summary

Summary

Riepilogo dei risultati della richiesta batch

RouteGuidance

Contiene elementi correlati alle linee guida. Questo campo è presente solo quando sono state richieste indicazioni ed è disponibile.

Nome Tipo Descrizione
instructionGroups

RouteInstructionGroup[]

Raggruppa una sequenza di elementi di istruzione correlati tra loro.
instructions

RouteInstruction[]

Elenco di istruzioni che descrivono le manovre.

RouteInstruction

Set di attributi che descrivono una manovra, ad esempio 'Gira a destra', 'Mantieni a sinistra', 'Prendi il traghetto', 'Prendi l'autostrada', 'Arriva'.

Nome Tipo Descrizione
combinedMessage

string

Messaggio leggibile per la manovra combinata con il messaggio dell'istruzione successiva. A volte è possibile combinare due istruzioni successive in un'unica istruzione rendendo più semplice seguire. In questo caso, il flag possibleCombineWithNext sarà true. Ad esempio:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Il flag possibleCombineWithNext nell'istruzione 10 è true. Ciò indica ai client di linee guida codificate che possono essere combinate con l'istruzione 11. Le istruzioni verranno combinate automaticamente per i client che richiedono indicazioni leggibili. Il campo combinedMessage contiene il messaggio combinato:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

Codice paese iso 3166-1 alfa-3. Ad esempio, USA.
drivingSide

DrivingSide

Indica la guida a sinistra e a destra al punto della manovra.
exitNumber

string

Numero di un'uscita autostrada presa dalla manovra corrente. Se un'uscita ha più numeri di uscita, verranno separati da "," e possibilmente aggregati da "-", ad esempio "10, 13-15".
instructionType

GuidanceInstructionType

Tipo dell'istruzione, ad esempio turno o modifica della forma stradale.
junctionType

JunctionType

Tipo di giunzione in cui si svolge la manovra. Per le rotatorie più grandi, vengono generate due istruzioni separate per entrare e lasciare la rotatoria.
maneuver

GuidanceManeuver

Codice che identifica la manovra.
message

string

Messaggio leggibile per la manovra.
point

LatLongPair

Una posizione rappresentata come latitudine e longitudine.
pointIndex

integer

Indice del punto nell'elenco di "punti" polilinei corrispondente al punto dell'istruzione.
possibleCombineWithNext

boolean

È possibile combinare facoltativamente l'istruzione con quella successiva. Questa operazione può essere usata per compilare messaggi come "Turn left and then turn right".
roadNumbers

string[]

Numero di strada del prossimo segmento di strada significativo dopo la manovra o le strade da seguire. Esempio: ["E34", "N205"]
roundaboutExitNumber

integer

Ciò indica quale uscita prendere a una rotatoria.
routeOffsetInMeters

integer

Distanza dall'inizio della route al punto dell'istruzione.
signpostText

string

Il testo su un segno che è più rilevante per la manovra o per la direzione che deve essere seguita.
stateCode

string

Una suddivisione (ad esempio, stato) del paese, rappresentata dalla seconda parte di un codice ISO 3166-2 . Questa opzione è disponibile solo per alcuni paesi/aree geografiche come gli Stati Uniti, il Canada e il Messico.
street

string

Nome della strada successiva significativo segmento dopo la manovra o della strada che dovrebbe essere seguita.
travelTimeInSeconds

integer

Tempo di viaggio stimato fino al punto corrispondente a routeOffsetInMeters.
turnAngleInDecimalDegrees

integer

Indica la direzione di un'istruzione. Se junctionType indica un'istruzione di turno:

  • 180 = U-turn
  • [-179, -1] = Turno sinistro
  • 0 = Dritto (un turno '0 gradi')
  • [1, 179] = Turno destro

Se junctionType indica un'istruzione di biforcazione:

  • <0 - tenere a sinistra
  • >0 - Mantenere destra

RouteInstructionGroup

Raggruppa una sequenza di elementi di istruzione correlati tra loro. L'intervallo di sequenze è vincolato con firstInstructionIndex e lastInstructionIndex. Quando vengono richiesti messaggi di testo leggibili per istruzioni (instructionType=text o tagged), il gruppo di istruzioni include un messaggio di riepilogo restituito quando disponibile.

Nome Tipo Descrizione
firstInstructionIndex

integer

Indice della prima istruzione nelle istruzioni e appartenente a questo gruppo.
groupLengthInMeters

integer

Lunghezza del gruppo.
groupMessage

string

Messaggio di riepilogo quando vengono richiesti messaggi di testo leggibili per istruzioni (instructionType=text o tag).
lastInstructionIndex

integer

Indice dell'ultima istruzione nelle istruzioni e appartenenza a questo gruppo.

RouteLeg

Descrizione di una parte di una route, costituita da un elenco di punti. Ogni punto di modo aggiuntivo fornito nella richiesta comporterà una gamba aggiuntiva nel percorso restituito.

Nome Tipo Descrizione
points

LatLongPair[]

Matrice punti
summary

RouteLegSummary

Oggetto Riepilogo per la sezione route.

RouteLegSummary

Oggetto Riepilogo per la sezione route.

Nome Tipo Descrizione
arrivalTime

string

Ora di arrivo stimata per il percorso o la gamba. L'ora è in formato UTC.
batteryConsumptionInkWh

number

Consumo energetico elettrico stimato in kilowatt ore (kWh) usando il modello di consumo elettrico. Incluso se il veicoloEngineType è impostato su elettrico e constantSpeedConsumptionInkWhPerHundredkm è specificato. Il valore della batteriaConsumptionInkWh include l'energia elettrica recuperata e può quindi essere negativa (che indica l'acquisizione di energia). Se vengono specificati sia maxChargeInkWh che currentChargeInkWh, il recupero verrà limitato per assicurarsi che il livello di carica della batteria non superi mai maxChargeInkWh. Se non vengono specificati maxChargeInkWh né currentChargeInkWh, nel calcolo del consumo viene assunto un recupero non vincolato.
departureTime

string

Ora di partenza stimata per il percorso o la gamba. L'ora è in formato UTC.
fuelConsumptionInLiters

number

Consumo stimato di carburante in litri usando il modello di consumo di combustione. Incluso se viene specificato vehicleEngineType su combustione e constantSpeedConsumptionInLitersPerHundredkm. Il valore sarà non negativo.
historicTrafficTravelTimeInSeconds

integer

Tempo di viaggio stimato calcolato usando i dati cronologici dipendenti dal tempo. Incluso solo se computeTravelTimeFor = tutto viene usato nella query.
lengthInMeters

integer

Length In Meters, proprietà
liveTrafficIncidentsTravelTimeInSeconds

integer

Tempo di viaggio stimato calcolato usando dati di velocità in tempo reale. Incluso solo se computeTravelTimeFor = tutto viene usato nella query.
noTrafficTravelTimeInSeconds

integer

Tempo di viaggio stimato calcolato come se non ci siano ritardi sul percorso a causa di condizioni di traffico (ad esempio la congestione). Incluso solo se computeTravelTimeFor = tutto viene usato nella query.
trafficDelayInSeconds

integer

Ritardo stimato in secondi causati dagli eventi imprevisti in tempo reale in base alle informazioni sul traffico. Per le route pianificate con orario di partenza in futuro, i ritardi sono sempre 0. Per restituire tempi di viaggio aggiuntivi usando diversi tipi di informazioni sul traffico, è necessario aggiungere il parametro computeTravelTimeFor=all.
travelTimeInSeconds

integer

Tempo di viaggio stimato in secondi che include il ritardo dovuto al traffico in tempo reale. Si noti che anche quando il traffico=false travelTimeInSeconds include ancora il ritardo dovuto al traffico. Se DepartAt è in futuro, il tempo di viaggio viene calcolato usando i dati del traffico cronologico dipendenti dal tempo.

RouteOptimizedWaypoint

Oggetto punto di modo ottimizzato.

Nome Tipo Descrizione
optimizedIndex

integer

Indice punto di modo ottimizzato dal sistema.
providedIndex

integer

Indice punto di modo fornito dall'utente.

RouteReport

Segnala le impostazioni effettive usate nella chiamata corrente.

Nome Tipo Descrizione
effectiveSettings

EffectiveSetting[]

Parametri o dati effettivi usati quando si chiama questa API di route.

RouteSection

Le sezioni di route contengono informazioni aggiuntive sulle parti di una route. Ogni sezione contiene almeno gli elementi startPointIndex, endPointIndexe sectionType.

Nome Tipo Descrizione
delayInSeconds

integer

Ritardo in secondi causati dall'evento imprevisto.
effectiveSpeedInKmh

integer

Velocità effettiva dell'evento imprevisto in km/h, mediata sull'intera lunghezza.
endPointIndex

integer

Indice dell'ultimo punto (offset 0) nella route a cui si applica questa sezione.
magnitudeOfDelay

DelayMagnitude

La grandezza del ritardo causato dall'incidente. Questi valori corrispondono ai valori del campo di risposta ty dell'API Get Traffic Incident Detail.
sectionType

ResponseSectionType

Tipi di sezione della risposta di route segnalata
simpleCategory

SimpleCategory

Tipo dell'evento imprevisto. Attualmente può essere JAM, ROAD_WORK, ROAD_CLOSURE o OTHER. Per informazioni dettagliate, vedere "tec".
startPointIndex

integer

Indice del primo punto (offset 0) nella route a cui si applica questa sezione.
tec

RouteSectionTec

Dettagli dell'evento di traffico, usando le definizioni nello standard TPEG2-TEC . Può contenere effectCode e causare elementi.
travelMode

ResponseTravelMode

Modalità di viaggio per il percorso calcolato. Il valore verrà impostato su other se la modalità richiesta di trasporto non è possibile in questa sezione

RouteSectionTec

Dettagli dell'evento di traffico, usando le definizioni nello standard TPEG2-TEC . Può contenere effectCode e causare elementi.

Nome Tipo Descrizione
causes

RouteSectionTecCause[]

Causa la matrice
effectCode

integer

Effetto sul flusso di traffico. Contiene un valore nella tabella tec001:EffectCode, come definito nello standard TPEG2-TEC . Può essere usato per gli eventi del traffico color-code in base alla gravità.

RouteSectionTecCause

Causa dell'evento di traffico. Può contenere elementi mainCauseCode e subCauseCode. Può essere usato per definire iconografia e descrizioni.

Nome Tipo Descrizione
mainCauseCode

integer

Causa principale dell'evento di traffico. Contiene un valore nella tabella tec002:CauseCode, come definito nello standard TPEG2-TEC .
subCauseCode

integer

Sottocausa dell'evento di traffico. Contiene un valore nella tabella delle cause secondarie definita da mainCauseCode, come definito nello standard TPEG2-TEC .

RouteSummary

Oggetto Riepilogo

Nome Tipo Descrizione
arrivalTime

string

Ora di arrivo stimata per il percorso o la gamba. L'ora è in formato UTC.
departureTime

string

Ora di partenza stimata per il percorso o la gamba. L'ora è in formato UTC.
lengthInMeters

integer

Length In Meters, proprietà
trafficDelayInSeconds

integer

Ritardo stimato in secondi causati dagli eventi imprevisti in tempo reale in base alle informazioni sul traffico. Per le route pianificate con orario di partenza in futuro, i ritardi sono sempre 0. Per restituire tempi di viaggio aggiuntivi usando diversi tipi di informazioni sul traffico, è necessario aggiungere il parametro computeTravelTimeFor=all.
travelTimeInSeconds

integer

Tempo di viaggio stimato in secondi che include il ritardo dovuto al traffico in tempo reale. Si noti che anche quando il traffico=false travelTimeInSeconds include ancora il ritardo dovuto al traffico. Se DepartAt è in futuro, il tempo di viaggio viene calcolato usando i dati del traffico cronologico dipendenti dal tempo.

SimpleCategory

Tipo dell'evento imprevisto. Attualmente può essere JAM, ROAD_WORK, ROAD_CLOSURE o OTHER. Per informazioni dettagliate, vedere "tec".

Nome Tipo Descrizione
JAM

string

Ingorgo.
OTHER

string

Altro.
ROAD_CLOSURE

string

Chiusura stradale.
ROAD_WORK

string

Lavoro stradale.

Summary

Riepilogo dei risultati della richiesta batch

Nome Tipo Descrizione
successfulRequests

integer

Numero di richieste riuscite nel batch
totalRequests

integer

Numero totale di richieste nel batch