Route - Post Route Directions Batch

Riferimento

Servizio:: Maps

Versione API:: 2025-01-01

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

L'API è una richiesta http che invia batch fino a 100 query in una singola chiamata all'API route .

Inviare una 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 (una 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?api-version=2025-01-01

Corpo POST per la richiesta batch

Per inviare le istruzioni query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice di batchItems nel formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 istruzioni query:

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

Un oggetto batchItem indicazioni può accettare una delle indicazioni supportatecorpo della richiesta

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

DirectionsResponse: se la query è stata completata correttamente.
Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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 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.
Accept-Language		string	Lingua in cui devono essere restituiti i risultati del routing. Per altre informazioni, vedere supporto per la localizzazione in Mappe di Azure.

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.

Accept-Language

string

Lingua in cui devono essere restituiti i risultati del routing.

Per altre informazioni, vedere supporto per la localizzazione in Mappe di Azure.

Corpo della richiesta

Nome	Tipo	Descrizione
batchItems	DirectionsBatchRequestItem[]	Elenco di query da elaborare.

Risposte

Nome	Tipo	Descrizione
200 OK	DirectionsBatchResponse	Richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.
Other Status Codes	MapsErrorResponse	Errore imprevisto. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

DirectionsBatchResponse

Richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Other Status Codes

MapsErrorResponse

Errore imprevisto.

Intestazioni

x-ms-error-code: string

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.

Nota

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 di mappe .
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 della 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 durante la creazione di un 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 questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

Tipo: apiKey
In: header

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

A Route Directions Batch request containing 2 queries

Esempio di richiesta

HTTP

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    }
  ]
}

Definizioni

Nome	Descrizione
Address	Il distretto amministrativo e l'area geografica del paese per i punti di via e i punti di manovra sul percorso del camion. Nota: supportato solo per truck travelMode.
AdminDistrict	Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.
AdminDistrictTruck	Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.
AdrTunnelRestrictionCodeEnum	Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose.
AvoidEnum	Specifica le restrizioni che il calcolo della route deve rispettare quando si determina la route. Evitare supporta più valori in una richiesta ed è supportato solo per la guida e il camion travelMode. Esempio: "avoid": ["limitedAccessHighways", "tollRoads"]
CountryRegion	Rappresenta un paese o un'area geografica contenente i dettagli correlati.
DirectionsBatchRequestBody	Elenco di query/richieste di istruzioni da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.
DirectionsBatchRequestItem	Oggetto Query batch
DirectionsBatchResponse	Questo oggetto viene restituito da una chiamata al servizio Directions Batch riuscita.
DirectionsBatchResponseItem	Elemento della risposta batch
DrivingSideEnum	Indica la guida a sinistra o a destra al punto della manovra. `Note`: supportato solo per truck travelMode.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
FeatureCollection	`GeoJSON` `FeatureCollection` oggetto che contiene un elenco di funzionalità. Per altre informazioni, vedere RFC 7946, sezione 3.3.
FeaturesItem	Oggetto funzionalità GeoJSON che contiene l'oggetto Geometry e proprietà aggiuntive della route.
FeaturesItemTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.
FeatureTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è `FeatureCollection`. Per altre informazioni, vedere RFC 7946.
GeoJsonPoint	Tipo geometry `GeoJSON Point` valido. Per informazioni dettagliate, vedere RFC 7946.
Hint	Informazioni aggiuntive che possono essere utili in seguito a una route. Oltre al testo dell'hint, questo elemento ha un hintType dell'attributo che specifica il riferimento all'hint, ad esempio "NextIntersection". Hint è un elemento facoltativo. `Note`: supportato solo per la guida di travelMode.
InputWaypointFeaturesItem	Specifica il punto di ingresso e viaWaypoint `GeoJSON` oggetto funzionalità e proprietà aggiuntive. Per altre informazioni, vedere RFC 7946.
InputWaypointProperties	Specifica le proprietà di un punto di partenza che è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.
InputWaypointTypeEnum	Tipo di punto di tragitto sulla route. Può trattarsi di una fermata o di una posizione intermedia che il percorso deve attraversare.
Instruction	Descrizione di una manovra in un set di direzioni.
Leg	Informazioni su una sezione di una route tra due punti di direzione. Altre informazioni sui campi contenuti in una gamba di itinerario:
ManeuverPointProperties	Specifica le istruzioni di guida e le proprietà aggiuntive per ogni punto di manovra nel percorso Gamba.
ManeuverTypeEnum	Il tipo di manovra descritto in questa raccolta dettagliata. Il ManeuverType fornisce informazioni per una parte della manovra specificata dall'istruzione corrispondente. Ad esempio, il tipo di manovra di un'istruzione può specificare TurnLeftThenTurnRight, mentre gli elementi di dettaglio associati possono fornire specifiche sulle manovre TurnLeft e TurnRight
MapsErrorDetail	Dettagli dell'errore.
MapsErrorResponse	Risposta di errore comune per le API di Mappe di Azure per restituire i dettagli dell'errore per le operazioni non riuscite.
MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
MultiLineStringGeometry	Specifica l'`GeoJSON` oggetto Geometry MultiLineString. Per altre informazioni, vedere RFC 7946.
OptimizedWaypoint	Oggetto punto di ottimizzazione.
Order	Sequenza per la visita di waypoint e viaWaypoints.
PointGeometry	Punto di origine passato come oggetto Geometry valido `GeoJSON` da cui calcolare il poligono dell'intervallo. Per informazioni dettagliate, vedere RFC 7946. `Note`: l'API blocca il punto di origine richiesto alla rete stradale più vicina e lo userà per il calcolo dell'intervallo. Verrà restituito come punto `center` nella risposta.
RegionTravelSummary	Riepilogo dei viaggi di distanza, tempo e distanza stradale a pedaggio per due tipi di entità: paese (ad esempio Stati Uniti, Canada) e divisione amministrativa o sottoregione (ad esempio "stato" negli Stati Uniti e nella "provincia" in Canada).
RoadTypeEnum	Tipo di strada. `Note`: supportato solo per la guida di travelMode.
RouteDirectionOptimizeRouteEnum	Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti. Esempio: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec	Specifica gli attributi del veicolo, ad esempio dimensioni, peso, velocità massima, tipo di carico e così via solo per il percorso dei camion. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo. IS`Note`: supportato solo per truck travelMode.
RouteOutputOptionEnum	Includere le informazioni di route desiderate dalla risposta. Per impostazione predefinita, l'itinerario è incluso nella risposta. Supporta più valori, ad esempio "routeOutputOptions": ["routePath", "regionNameSummary"]
RoutePathPoint	Fa riferimento all'indice di un punto all'interno di una gamba specifica di un percorso.
RoutePathProperties	Specifica le proprietà che descrivono il percorso della route nella risposta.
RoutePathRange	Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.
RoutePathTravelModeEnum	Modalità di viaggio per il percorso della risposta.
SideOfStreetEnum	Il lato della strada in cui si trova la destinazione in base alla direzione di arrivo. Questo campo si applica solo all'ultimo punto di manovra.
Step	Una gamba del percorso contiene istruzioni turn-by-turn. Un passo si riferisce a una gamma di un percorso tra due punti di manovra consecutivi.
SubLeg	Informazioni su un segmento dell'itinerario Leg definito dai punti di direzione del percorso e da qualsiasi punto intermedio via strada. Ad esempio, se il percorso Leg ha due punti via via oltre ai punti di partenza e di arrivo, ci sarebbero tre (3) gambe secondarie di percorso.
Summary	Riepilogo per la richiesta batch
TrafficCongestionEnum	Livello di congestione del traffico lungo il percorso. `Note`: supportato solo per la guida di travelMode
TrafficDataUsedEnum	Tipo di dati sul traffico in tempo reale usati per generare la route.
TravelModeEnum	Modalità di viaggio per il percorso richiesto. Se non definito, il valore predefinito è "guida" che restituisce il percorso ottimizzato per le auto. `Note`: per il trasporto di camionMode, il percorso del camion richiesto potrebbe non essere disponibile per l'intero percorso. Se il percorso del camion non è disponibile per una sezione specifica, l'elemento travelMode della risposta per tale sezione sarà "altro". Esempio: "travelMode":"driving"
VehicleLoadTypeEnum	Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta.
ViaWaypointProperties	Specifica le proprietà di un `ViaWaypoint` che è un punto di percorso che deve essere passato o visitato lungo un percorso o un viaggio.
WaypointProperties	Specifica le proprietà di un punto di partenza che è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.

Address

Object

Il distretto amministrativo e l'area geografica del paese per i punti di via e i punti di manovra sul percorso del camion. Nota: supportato solo per truck travelMode.

Nome	Tipo	Descrizione
adminDistricts	AdminDistrictTruck[]	Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.
countryRegion	CountryRegion	Rappresenta un paese o un'area geografica contenente i dettagli correlati.

AdminDistrict

Object

Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica.

Nome	Tipo	Descrizione
distanceInMeters	number	Distanza totale percorsa in metri all'interno del distretto amministrativo.
durationInSeconds	integer (int64)	Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.
durationTrafficInSeconds	integer (int64)	Tempo necessario, in secondi, per spostarsi in un `TravelDistance` corrispondente con condizioni di traffico correnti. Questo valore viene fornito se `optimizeRoute` include considerazioni sul traffico.
longName	string	Nome lungo di un indirizzo, ad esempio Washington.
tollDistanceInMeters	number	Distanza totale, misurata in metri, lungo il percorso che include strade a pedaggio.

AdminDistrictTruck

Object

Nome	Tipo	Descrizione
shortName	string	Il nome breve per il campo adminDistrict corrispondente, Per adminDistrict[0], potrebbe essere un nome breve di stato, ad esempio WA. Questa opzione è disponibile solo per Stati Uniti, Canada e Messico.

AdrTunnelRestrictionCodeEnum

Enumerazione

Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose.

Valore	Descrizione
B	I veicoli con codice B sono limitati dalle strade con categorie di tunnel ADR B, C, D ed E.
C	I veicoli con codice C sono limitati dalle strade con categorie di tunnel ADR C, D ed E
D	I veicoli con codice D sono limitati dalle strade con categorie di tunnel ADR D ed E.
E	I veicoli con codice E sono limitati dalle strade con categoria tunnel ADR E.

AvoidEnum

Enumerazione

Specifica le restrizioni che il calcolo della route deve rispettare quando si determina la route. Evitare supporta più valori in una richiesta ed è supportato solo per la guida e il camion travelMode.

Esempio: "avoid": ["limitedAccessHighways", "tollRoads"]

Valore	Descrizione
borderCrossings	Evita di attraversare i confini del paese nel percorso.
ferries	Evita l'uso di traghetti nel percorso.
limitedAccessHighways	Evita l'uso di autostrade ad accesso limitato nel percorso.
lowEmissionZones	Evita zone a basse emissioni nel percorso. `Note`: supportato solo per truck travelMode.
tollRoads	Evita l'uso di strade a pedaggio nel percorso.
tunnels	Evita l'uso di tunnel nella route. `Note`: supportato solo per truck travelMode.
unpavedRoads	Evita strade non pavimentate nel percorso. `Note`: supportato solo per truck travelMode.

CountryRegion

Object

Rappresenta un paese o un'area geografica contenente i dettagli correlati.

Nome	Tipo	Descrizione
ISO	string	ISO del paese/area geografica rappresenta un codice paese/area geografica ISO 3166-1 Alfa-2
name	string	nome del paese/area geografica

DirectionsBatchRequestBody

Object

Elenco di query/richieste di istruzioni da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.

Nome	Tipo	Descrizione
batchItems	DirectionsBatchRequestItem[]	Elenco di query da elaborare.

DirectionsBatchRequestItem

Object

Oggetto Query batch

Nome	Tipo	Valore predefinito	Descrizione
arriveAt	string (date-time)		Data e ora di arrivo nel punto di destinazione formattato come valore `dateTime` definito da RFC 3339, sezione 5.6. Quando non viene specificata una differenza di fuso orario, si presuppone l'ora UTC. Il parametro `arriveAt` non può essere utilizzato insieme a `departAt`. Esempio: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid	AvoidEnum[]		Specifica le restrizioni che il calcolo della route deve rispettare quando si determina la route. Evitare supporta più valori in una richiesta ed è supportato solo per la guida e il camion travelMode. Esempio: "avoid": ["limitedAccessHighways", "tollRoads"]
departAt	string (date-time)		Data e ora di partenza dal punto di origine formattato come valore `dateTime` definito da RFC 3339, sezione 5.6. Quando non viene specificata una differenza di fuso orario, si presuppone l'ora UTC. Se il `departAt` non è impostato, il valore predefinito è l'ora corrente. Esempio: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		I percorsi di guida e a piedi sono definiti da un set di punti di marcia (fermate) e viaWaypoint (posizioni intermedie che il percorso deve attraversare). È possibile avere un massimo di 25 punti di direzione e un massimo di 10 punti di viaWay tra ogni set di punti di percorso. Il percorso del camion supporta fino a 150 punti di tragitto e viaWaypoint non è supportato. Un itinerario deve avere almeno 2 punti di partenza e i punti di partenza e di arrivo del percorso non possono essere viaWaypoint. Sia i percorsi waypoint che i percorsi viaWaypoint devono essere specificati come un oggetto funzione punto GeoJSON valido insieme a pointIndex che specifica l'ordine delle posizioni. Per altre informazioni sul formato GeoJSON, vedere RFC 7946.
heading	integer (int64) minimum: 0 maximum: 359		Direzione iniziale del veicolo in gradi a partire da nord reale e continua in senso orario. Nord è di 0 gradi, est è di 90 gradi, sud è di 180 gradi, ovest è di 270 gradi. Valori possibili da 0 a 359
maxRouteCount	integer (int64) minimum: 1 maximum: 3		Numero massimo di route da restituire. Disponibile per le modalità di guida e di viaggio del camion. Per i percorsi di guida, questo parametro supporta le route con un massimo di due punti di direzione oltre all'origine e alla destinazione ed evitare il parametro non deve essere impostato. Impostazione predefinita: "maxRouteCount":1 Minimo: "maxRouteCount":1 Massimo: "maxRouteCount":3
optimizeRoute	RouteDirectionOptimizeRouteEnum	fastestWithoutTraffic	Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti. Esempio: "optimizeRoute":"shortest"
optimizeWaypointOrder	boolean	False	Riordinare i punti di percorso usando un algoritmo euristico rapido per ridurre il costo di route specificato con il parametro Optimize. L'origine e la destinazione vengono escluse dal punto di partenza ottimizzato e la relativa posizione viene considerata fissa. I valori accettabili sono true o false. `Note`: supportato solo per truck travelMode.
optionalId	string		ID della richiesta che verrà visualizzata nell'oggetto batchItem corrispondente.
routeOutputOptions	RouteOutputOptionEnum[]	[ "itinerary" ]	Includere le informazioni di route desiderate dalla risposta. Per impostazione predefinita, l'itinerario è incluso nella risposta. Supporta più valori, ad esempio "routeOutputOptions": ["routePath", "regionNameSummary"]
travelMode	TravelModeEnum	driving	Modalità di viaggio per il percorso richiesto. Se non definito, il valore predefinito è "guida" che restituisce il percorso ottimizzato per le auto. `Note`: per il trasporto di camionMode, il percorso del camion richiesto potrebbe non essere disponibile per l'intero percorso. Se il percorso del camion non è disponibile per una sezione specifica, l'elemento travelMode della risposta per tale sezione sarà "altro". Esempio: "travelMode":"driving"
type	FeatureTypeEnum		Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è `FeatureCollection`. Per altre informazioni, vedere RFC 7946.
vehicleSpec	RouteDirectionVehicleSpec		Specifica gli attributi del veicolo, ad esempio dimensioni, peso, velocità massima, tipo di carico e così via solo per il percorso dei camion. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo. `Note`: supportato solo per truck travelMode

DirectionsBatchResponse

Object

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

Nome	Tipo	Descrizione
batchItems	DirectionsBatchResponseItem[]	Matrice contenente i risultati del batch.
summary	Summary	Riepilogo per la richiesta batch

DirectionsBatchResponseItem

Object

Elemento della risposta batch

Nome	Tipo	Descrizione
alternativeRoutes	FeatureCollection[]	Percorso alternativo.
error	ErrorDetail	Dettagli dell'errore.
features	FeaturesItem[]	`GeoJSON` oggetto feature che contiene l'oggetto Geometry e le proprietà aggiuntive. Per altre informazioni, vedere RFC 7946, sezione 3.2.
optionalId	string	ID della richiesta che verrà visualizzata nell'oggetto batchItem corrispondente.
type	FeatureTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è `FeatureCollection`. Per altre informazioni, vedere RFC 7946.

DrivingSideEnum

Enumerazione

Indica la guida a sinistra o a destra al punto della manovra. Note: supportato solo per truck travelMode.

Valore	Descrizione
Left	Guida sul lato sinistro.
Right	Guida laterale destra.

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.

FeatureCollection

Object

GeoJSON FeatureCollection oggetto che contiene un elenco di funzionalità. Per altre informazioni, vedere RFC 7946, sezione 3.3.

Nome	Tipo	Descrizione
features	FeaturesItem[]	`GeoJSON` oggetto feature che contiene l'oggetto Geometry e le proprietà aggiuntive. Per altre informazioni, vedere RFC 7946, sezione 3.2.
type	FeatureTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è `FeatureCollection`. Per altre informazioni, vedere RFC 7946.

FeaturesItem

Object

Oggetto funzionalità GeoJSON che contiene l'oggetto Geometry e proprietà aggiuntive della route.

Nome	Tipo	Descrizione
bbox	number[] (double)	Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati dei rettangoli sono definiti dai valori di latitudine e longitudine. Per altre informazioni, vedere RFC 7946, sezione 5. Esempio: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	RouteDirectionsGeometry: MultiLineStringGeometry PointGeometry	Oggetto Geometry valido `GeoJSON`. Per altre informazioni, vedere RFC 7946.
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	Specifica le proprietà delle caratteristiche del percorso, ad esempio itinerario, gambe percorso e geometria, riepilogo dei viaggi.
type	FeaturesItemTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

FeaturesItemTypeEnum

Enumerazione

Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

Valore	Descrizione
Feature	Specifica il tipo di oggetto Feature `GeoJSON`.

FeatureTypeEnum

Enumerazione

Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è FeatureCollection. Per altre informazioni, vedere RFC 7946.

Valore	Descrizione
FeatureCollection	Specifica il tipo di oggetto `GeoJSONFeatureCollection`.

GeoJsonPoint

Object

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.

Nome	Tipo	Descrizione
coordinates	number[] (double)	Un `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. altitudine/elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946.
type	string: Point	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Hint

Object

Informazioni aggiuntive che possono essere utili in seguito a una route. Oltre al testo dell'hint, questo elemento ha un hintType dell'attributo che specifica il riferimento all'hint, ad esempio "NextIntersection". Hint è un elemento facoltativo. Note: supportato solo per la guida di travelMode.

Nome	Tipo	Descrizione
hintType	string	tipo hint.
text	string	testo hint.

InputWaypointFeaturesItem

Object

Specifica il punto di ingresso e viaWaypoint GeoJSON oggetto funzionalità e proprietà aggiuntive. Per altre informazioni, vedere RFC 7946.

Nome	Tipo	Descrizione
geometry	GeoJsonPoint: PointGeometry	Tipo geometry `GeoJSON Point` valido. Per informazioni dettagliate, vedere RFC 7946.
properties	InputWaypointProperties	Specifica le proprietà di un punto di partenza che è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.
type	FeaturesItemTypeEnum	Specifica il tipo di `GeoJSON`. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.

InputWaypointProperties

Object

Specifica le proprietà di un punto di partenza che è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.

Nome	Tipo	Valore predefinito	Descrizione
pointIndex	integer (int64)		Identificare e ordinare la sequenza di punti di direzione nella route. Il valore predefinito è il `index value` di una matrice di funzionalità.
pointType	InputWaypointTypeEnum	waypoint	Tipo di punto di tragitto sulla route. Può trattarsi di una fermata o di una posizione intermedia che il percorso deve attraversare.

InputWaypointTypeEnum

Enumerazione

Tipo di punto di tragitto sulla route. Può trattarsi di una fermata o di una posizione intermedia che il percorso deve attraversare.

Valore	Descrizione
viaWaypoint	Un viaWaypoint è un punto di percorso specifico che deve essere passato o visitato lungo un percorso o un viaggio. `Note`: supportato solo per la guida di travelMode.
waypoint	Un punto di partenza è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.

Instruction

Object

Descrizione di una manovra in un set di direzioni.

Nome	Tipo	Descrizione
drivingSide	DrivingSideEnum	Indica la guida a sinistra o a destra al punto della manovra. `Note`: supportato solo per truck travelMode.
formattedText	string	Descrizione del testo formattato dell'istruzione.
hints	Hint[]	Informazioni aggiuntive che possono essere utili in seguito a una route. Oltre al testo dell'hint, questo elemento ha un hintType dell'attributo che specifica il riferimento all'hint, ad esempio "NextIntersection". Hint è un elemento facoltativo e un passaggio di route può contenere più hint. `Note`: supportato solo per la guida di travelMode
maneuverType	ManeuverTypeEnum	Il tipo di manovra descritto in questa raccolta dettagliata. Il ManeuverType fornisce informazioni per una parte della manovra specificata dall'istruzione corrispondente. Ad esempio, il tipo di manovra di un'istruzione può specificare TurnLeftThenTurnRight, mentre gli elementi di dettaglio associati possono fornire specifiche sulle manovre TurnLeft e TurnRight
text	string	Descrizione di testo normale dell'istruzione.

Leg

Object

Informazioni su una sezione di una route tra due punti di direzione. Altre informazioni sui campi contenuti in una gamba di itinerario:

Nome	Tipo	Descrizione
arrivalAt	string (date-time)	L'ora di arrivo stimata per la gamba, che tiene conto delle condizioni del traffico, viene formattata come valore dateTime definito da RFC 3339, sezione 5.6. Farà riferimento all'offset del fuso orario `departAt` o `arrivalAt`. In caso contrario, verrà usata l'ora UTC.
departureAt	string (date-time)	L'ora di partenza stimata per la gamba, che tiene conto delle condizioni del traffico, viene formattata come valore dateTime definito da RFC 3339, sezione 5.6. Farà riferimento all'offset del fuso orario `departAt` o `arrivalAt`. In caso contrario, verrà usata l'ora UTC.
description	string	Breve descrizione del percorso.
distanceInMeters	number	La distanza fisica in metri coperti da una gamba di percorso.
durationInSeconds	integer (int64)	Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.
durationTrafficInSeconds	integer (int64)	Tempo necessario, in secondi, per spostarsi in un `TravelDistance` corrispondente con condizioni di traffico correnti. Questo valore viene fornito se `optimizeRoute` include considerazioni sul traffico.
regionTravelSummary	RegionTravelSummary	Includere il riepilogo dei viaggi di distanza, tempo e distanza stradale a pedaggio per due tipi di entità: paese (ad esempio STATI UNITI, Canada) e divisione amministrativa o sottoregione (ad esempio "stato" negli Stati Uniti e nella "provincia" in Canada).
routePathRange	RoutePathRange	Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.
subLegs	SubLeg[]	Informazioni su un segmento dell'itinerario Leg definito dai punti di direzione del percorso e da qualsiasi punto intermedio via strada. Ad esempio, se il percorso Leg ha due punti via via oltre ai punti di partenza e di arrivo, ci sarebbero tre (3) gambe secondarie di percorso.

ManeuverPointProperties

Object

Specifica le istruzioni di guida e le proprietà aggiuntive per ogni punto di manovra nel percorso Gamba.

Nome	Tipo	Valore predefinito	Descrizione
address	Address		Il distretto amministrativo e l'area geografica del paese per i punti di via e i punti di manovra sul percorso del camion. Nota: supportato solo per truck travelMode.
compassDirection	string		Direzione di viaggio associata a una manovra su un percorso, ad esempio sud o sud-ovest. `Note`: supportato solo per la guida di travelMode.
distanceInMeters	number		Distanza fisica in metri coperti da questo passaggio del percorso.
durationInSeconds	integer (int64)		Tempo necessario, in secondi, per spostarsi in un `TravelDistance`corrispondente.
exitIdentifier	string		Nome o numero dell'uscita associata a questo passaggio di route.
instruction	Instruction		Descrizione di una manovra in un set di direzioni.
order	Order		Sequenza per la visita di waypoint e viaWaypoints.
routePathPoint	RoutePathPoint		Fa riferimento all'indice di un punto all'interno di una gamba specifica di un percorso.
sideOfStreet	SideOfStreetEnum		Il lato della strada in cui si trova la destinazione in base alla direzione di arrivo. Questo campo si applica solo all'ultimo punto di manovra.
signs	string[]		Testo della segnaletica per il percorso. Potrebbero essere presenti più di un valore di segno.
steps	Step[]		Passi tra due punti di manovra consecutivi.
towardsRoadName	string		Nome della strada che il percorso va verso nel primo `ManeuverPoint`.
travelMode	RoutePathTravelModeEnum	driving	Modalità di viaggio per il percorso della risposta.
type	string: ManeuverPoint		Tipo di output.

ManeuverTypeEnum

Enumerazione

Il tipo di manovra descritto in questa raccolta dettagliata. Il ManeuverType fornisce informazioni per una parte della manovra specificata dall'istruzione corrispondente. Ad esempio, il tipo di manovra di un'istruzione può specificare TurnLeftThenTurnRight, mentre gli elementi di dettaglio associati possono fornire specifiche sulle manovre TurnLeft e TurnRight

Valore	Descrizione
ArriveFinish	Arrivare alla destinazione finale.
ArriveIntermediate	Arrivare a un punto di via intermedio.
BearLeft	Orso a sinistra.
BearLeftThenBearLeft	Bear left and then bear left and then bear left again.
BearLeftThenBearRight	Bear left and then bear right.
BearLeftThenTurnLeft	Orso a sinistra e poi girare a sinistra.
BearLeftThenTurnRight	Orso a sinistra e poi girare a destra.
BearRight	Bear right.
BearRightThenBearLeft	Bear right and then bear left.
BearRightThenBearRight	Bear right and then bear right again.
BearRightThenTurnLeft	Porta a destra e poi gira a sinistra.
BearRightThenTurnRight	Porta a destra e poi gira a destra.
BearThenKeep	Eseguire l'istruzione e quindi un'istruzione keep
BearThenMerge	Eseguire l'istruzione bear e quindi un'istruzione di merge.
Continue	Continua sulla strada corrente.
DepartIntermediateStop	Lasciare un punto di marcia intermedio in una direzione e una strada diversa da quella in cui sei arrivato.
DepartIntermediateStopReturning	Lasciare un punto intermedio nella stessa direzione e sulla stessa strada su cui sei arrivato.
DepartStart	Lasciare il punto di partenza.
EnterRoundabout	Entrare in una rotatoria.
EnterThenExitRoundabout	Entrare e uscire da una rotatoria.
ExitRoundabout	Uscire da una rotatoria.
ExitRoundaboutLeft	Alla rotatoria prendere l'uscita a sinistra.
ExitRoundaboutRight	Alla rotatoria prendere l'uscita a destra.
Follow	Seguire.
GoAroundRoundabout	Andate in giro per la rotatoria.
KeepLeft	Continuate a sinistra su una strada diversa.
KeepOnRampLeft	Continuate a sinistra e continuate sulla rampa.
KeepOnRampRight	Continuate a destra e continuate sulla rampa.
KeepOnRampStraight	Continuate dritto e continuate su rampa.
KeepRight	Continuate a destra su una strada diversa.
KeepStraight	Continuate dritto su una strada diversa.
KeepToStayLeft	Continuate a sinistra per rimanere sulla stessa strada.
KeepToStayRight	Mantieni giusto per rimanere sulla stessa strada.
KeepToStayStraight	Continuate dritto per rimanere sulla stessa strada.
MergeFreeway	Unisci su una strada libera.
MergeHighway	Unisci su un'autostrada.
MergeMotorway	Unisci su un'autostrada.
MotorwayExitLeft	Prendi l'uscita sinistra.
MotorwayExitRight	Esci a destra.
None	Nessuna istruzione.
RampThenHighwayLeft	Prendi la rampa sinistra sull'autostrada. Questa è parte di un'istruzione combinata.
RampThenHighwayRight	Prendi la rampa destra sull'autostrada. Questa è parte di un'istruzione combinata.
RampThenHighwayStraight	Resta dritto per prendere la rampa sull'autostrada. Questa è parte di un'istruzione combinata.
RoadNameChange	Modifiche al nome della strada.
SwitchToMainRoad	Passare alla strada principale.
SwitchToParallelRoad	Passare alla strada parallela.
Take	Prendi la strada. Questa istruzione viene utilizzata quando si entra o si esce da un traghetto.
TakeExit	Prendi l'uscita.
TakeFerry	Prendi il traghetto.
TakeRamp	Prendi rampa.
TakeRampLeft	Prendi la rampa a sinistra.
TakeRampRight	Prendi la rampa a destra.
TakeRampStraight	Resta dritto per prendere rampa.
TurnBack	Torna indietro bruscamente.
TurnLeft	Gira a sinistra.
TurnLeftSharp	Prendi un turno sinistro tagliente.
TurnLeftThenBearLeft	Gira a sinistra e poi porta a sinistra.
TurnLeftThenBearRight	Gira a sinistra e poi porta a destra.
TurnLeftThenTurnLeft	Girare a sinistra e quindi girare di nuovo a sinistra.
TurnLeftThenTurnRight	Girare a sinistra e quindi girare a destra.
TurnRight	Gira a destra.
TurnRightSharp	Prendi una curva destra nitida.
TurnRightThenBearLeft	Girare a destra e poi sopportare a sinistra.
TurnRightThenBearRight	Gira a destra e poi porta a destra.
TurnRightThenTurnLeft	Girare a destra e quindi girare a sinistra.
TurnRightThenTurnRight	Girare a destra e quindi girare di nuovo a destra
TurnThenMerge	Istruzione turn seguita da un'istruzione di merge.
TurnToStayLeft	Gira a sinistra per rimanere sulla stessa strada.
TurnToStayRight	Gira a destra per rimanere sulla stessa strada.
UTurn	Fare un u-turn per andare nella direzione opposta.
Unknown	L'istruzione è sconosciuta.
Wait	Aspettare
Walk	Cammina!

MapsErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	MapsErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

MapsErrorResponse

Object

Risposta di errore comune per le API di Mappe di Azure per restituire i dettagli dell'errore per le operazioni non riuscite.

Nome	Tipo	Descrizione
error	MapsErrorDetail	Dettagli dell'errore.

MapsInnerError

Object

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

MultiLineStringGeometry

Object

Specifica l'GeoJSON oggetto Geometry MultiLineString. Per altre informazioni, vedere RFC 7946.

Nome	Tipo	Descrizione
coordinates	number[] (double)	Coordinate per la geometria `GeoJson MultiLineString`.
type	string: MultiLineString	Specifica il tipo di geometria per l'oggetto Geometry `GeoJSON`. Per altre informazioni, vedere RFC 7946.

OptimizedWaypoint

Object

Oggetto punto di ottimizzazione.

Nome	Tipo	Descrizione
inputIndex	integer (int64)	Indice del punto di modo fornito dall'utente.
optimizedIndex	integer (int64)	Indice del punto di modo ottimizzato dal sistema.

Order

Object

Sequenza per la visita di waypoint e viaWaypoints.

Nome	Tipo	Descrizione
inputIndex	integer (int64)	Indice fornito dall'utente per gli input waypoint e viaWaypoint.
optimizedIndex	integer (int64)	Waypoint ottimizzato per il sistema e indice viaWaypoint.

PointGeometry

Object

Punto di origine passato come oggetto Geometry valido GeoJSON da cui calcolare il poligono dell'intervallo. Per informazioni dettagliate, vedere RFC 7946.

Note: l'API blocca il punto di origine richiesto alla rete stradale più vicina e lo userà per il calcolo dell'intervallo. Verrà restituito come punto center nella risposta.

Nome	Tipo	Descrizione
coordinates	number[] (double)	Un `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. altitudine/elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946.
type	string: Point	Specifica il tipo di geometria per l'oggetto Geometry `GeoJSON`. Per altre informazioni, vedere RFC 7946.

RegionTravelSummary

Object

Riepilogo dei viaggi di distanza, tempo e distanza stradale a pedaggio per due tipi di entità: paese (ad esempio Stati Uniti, Canada) e divisione amministrativa o sottoregione (ad esempio "stato" negli Stati Uniti e nella "provincia" in Canada).

Nome	Tipo	Descrizione
adminDistricts	AdminDistrict[]	matrice adminDistrict.
countryRegion	CountryRegion	Rappresenta un paese o un'area geografica contenente i dettagli correlati.
distanceInMeters	number	Proprietà Length In Meters
durationInSeconds	integer (int64)	Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.
durationTrafficInSeconds	integer (int64)	Tempo necessario, in secondi, per spostarsi in un `TravelDistance` corrispondente con condizioni di traffico correnti. Questo valore viene fornito se `optimizeRoute` include considerazioni sul traffico.
tollDistanceInMeters	number	Distanza totale, misurata in metri, lungo il percorso che include strade a pedaggio.

RoadTypeEnum

Enumerazione

Tipo di strada. Note: supportato solo per la guida di travelMode.

Valore	Descrizione
Arterial	Arterioso.
Ferry	Traghetto.
Highway	Autostrada.
LimitedAccessHighway	LimitedAccessHighway.
MajorRoad	MajorRoad.
NotApplicable	NotApplicable.
Ramp	Rampa.
Street	Via.
WalkingPath	WalkingPath.

RouteDirectionOptimizeRouteEnum

Enumerazione

Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti.

Esempio: "optimizeRoute":"shortest"

Valore	Descrizione
fastestAvoidClosureWithoutTraffic	Il percorso viene calcolato per ridurre al minimo il tempo ed evitare le chiuse stradali. Nel calcolo non vengono utilizzate informazioni sul traffico ad eccezione delle chiuse stradali. `Note`: supportato solo per la guida di travelMode.
fastestWithTraffic	La route viene calcolata per ridurre al minimo il tempo usando le informazioni sul traffico correnti. `Note`: supportato solo per la guida e il trasporto di camionMode.
fastestWithoutTraffic	Trova la route più veloce, senza considerare le informazioni sul traffico.
shortest	Il percorso viene calcolato per ridurre al minimo la distanza. Le informazioni sul traffico non vengono usate.

RouteDirectionVehicleSpec

Object

Specifica gli attributi del veicolo, ad esempio dimensioni, peso, velocità massima, tipo di carico e così via solo per il percorso dei camion. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo.

ISNote: supportato solo per truck travelMode.

Nome	Tipo	Valore predefinito	Descrizione
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose.
axleCount	integer (int64)		Numero di assi sul veicolo.
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	Peso per asse del veicolo in kg. Il valore 0 indica che le restrizioni di peso per asse non vengono considerate.
height	number (double) minimum: 0 maximum: 1000000	0	Altezza del veicolo in metri. Il valore 0 indica che le restrizioni di altezza non vengono considerate.
isVehicleCommercial	boolean	False	Indica se il veicolo viene utilizzato per scopi commerciali. I veicoli commerciali potrebbero non essere autorizzati a guidare su alcune strade.
length	number (double) minimum: 0 maximum: 1000000	0	Lunghezza del veicolo in metri. Il valore 0 indica che le restrizioni di lunghezza non vengono considerate.
loadType	VehicleLoadTypeEnum[]		Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta.
maxSpeed	integer (int64) minimum: 0 maximum: 250	0	Velocità massima del veicolo in km/ora. La velocità massima nel profilo del veicolo viene utilizzata per verificare se un veicolo è consentito sulle autostrade. Il valore 0 indica che un valore appropriato per il veicolo verrà determinato e applicato durante la pianificazione del percorso. È possibile eseguire l'override di un valore diverso da zero durante la pianificazione della route. Ad esempio, il flusso di traffico corrente è di 60 km/ora. Se la velocità massima del veicolo è impostata su 50 km/ora, il motore di instradamento considererà 60 km/ora in quanto si tratta della situazione attuale. Se la velocità massima del veicolo viene fornita come 80 km/ora, ma il flusso di traffico corrente è di 60 km/ora, il motore di instradamento utilizzerà di nuovo 60 km/ora.
weight	integer (int64) minimum: 0 maximum: 1000000	0	Peso del veicolo in kg. Il valore 0 indica che le restrizioni di peso non vengono considerate.
width	number (double) minimum: 0 maximum: 1000000	0	Larghezza del veicolo in metri. Il valore 0 indica che le restrizioni di larghezza non vengono considerate.

RouteOutputOptionEnum

Enumerazione

Includere le informazioni di route desiderate dalla risposta. Per impostazione predefinita, l'itinerario è incluso nella risposta.

Supporta più valori, ad esempio "routeOutputOptions": ["routePath", "regionNameSummary"]

Valore	Descrizione
itinerary	Includere indicazioni dettagliate nella risposta. Le indicazioni dettagliate sono fornite come "ManeuverPoints" e contengono dettagli come le istruzioni turn-by-turn.
regionTravelSummary	Includere il riepilogo delle distanze, del tempo e della distanza stradale a pedaggio per due tipi di entità: paese (ad esempio, Stati Uniti, Canada) e divisione amministrativa o sottoregione (ad esempio, "stato" negli Stati Uniti e nella "provincia" in Canada). `Note`: supportato solo per la guida e il viaggio a piediMode
routePath	Includere un GeoJSON MultiLineString RFC 7946, sezione 3.1.5 che descrivono il percorso della route nella risposta.
routeSummary	Includere solo il tempo di viaggio e la distanza per il percorso e non fornire altre informazioni.

RoutePathPoint

Object

Fa riferimento all'indice di un punto all'interno di una gamba specifica di un percorso.

Nome	Tipo	Descrizione
legIndex	integer (int64)	L'indice leg del percorso è un numero sequenziale assegnato a ogni gamba del percorso per identificare e distinguere tra segmenti diversi del percorso.
pointIndex	integer (int64)	Indice di un punto all'interno di una gamba specifica.

RoutePathProperties

Object

Specifica le proprietà che descrivono il percorso della route nella risposta.

Nome	Tipo	Descrizione
arrivalAt	string (date-time)	L'ora di arrivo stimata per la gamba, che tiene conto delle condizioni del traffico, viene formattata come valore `dateTime` definito da RFC 3339, sezione 5,6. Farà riferimento all'offset del fuso orario `departAt` o `arrivalAt`. In caso contrario, verrà usata l'ora UTC.
departureAt	string (date-time)	L'ora di partenza stimata per la gamba, che tiene conto delle condizioni del traffico, viene formattata come valore `dateTime` definito da RFC 3339, sezione 5.6. Farà riferimento all'offset del fuso orario `departAt` o `arrivalAt`. In caso contrario, verrà usata l'ora UTC.
distanceInMeters	number	Distanza fisica in metri coperti dall'intero percorso.
durationInSeconds	integer (int64)	Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.
durationTrafficInSeconds	integer (int64)	Tempo necessario, in secondi, per spostarsi in un `TravelDistance` corrispondente con condizioni di traffico correnti. Questo valore viene fornito se `optimizeRoute` include considerazioni sul traffico.
legs	Leg[]	Matrice di gambe di percorso. Per altre informazioni, vedere la descrizione dell'oggetto Leg di route.
optimizedWaypoints	OptimizedWaypoint[]	Sequenza ottimizzata di punti di direzione. Mostra l'indice della sequenza di punti di percorso fornita dall'utente per gli elenchi originali e ottimizzati.
resourceId	string	ID univoco per la risorsa.
trafficCongestion	TrafficCongestionEnum	Livello di congestione del traffico lungo il percorso. `Note`: supportato solo per la guida di travelMode
trafficDataUsed	TrafficDataUsedEnum	Tipo di dati sul traffico in tempo reale usati per generare la route.
type	string: RoutePath	Tipo di output.

RoutePathRange

Object

Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.

Nome	Tipo	Descrizione
legIndex	integer (int64)	L'indice leg del percorso è un numero sequenziale assegnato a ogni gamba del percorso per identificare e distinguere tra segmenti diversi del percorso.
range	integer[] (int64)	Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.

RoutePathTravelModeEnum

Enumerazione

Modalità di viaggio per il percorso della risposta.

Valore	Descrizione
driving	Itinerari ottimizzati per le auto.
other	Route TagsMode viene restituito come "altro" per il camion travelMode quando il percorso del camion non è disponibile per una sezione specifica di un itinerario.
truck	Itinerari ottimizzati per autocarri di grandi dimensioni in base alla specifica del veicolo.
walking	Itinerari ottimizzati per i pedoni.

SideOfStreetEnum

Enumerazione

Il lato della strada in cui si trova la destinazione in base alla direzione di arrivo. Questo campo si applica solo all'ultimo punto di manovra.

Valore	Descrizione
Left	A sinistra.
Right	A destra.
Unknown	Sconosciuto.

Step

Object

Una gamba del percorso contiene istruzioni turn-by-turn. Un passo si riferisce a una gamma di un percorso tra due punti di manovra consecutivi.

Nome	Tipo	Descrizione
compassDegrees	number	Direzione in gradi. `Note`: supportato solo per la guida di travelMode.
maneuverType	ManeuverTypeEnum	Il tipo di manovra descritto in questa raccolta dettagliata. Il ManeuverType fornisce informazioni per una parte della manovra specificata dall'istruzione corrispondente. Ad esempio, il tipo di manovra di un'istruzione può specificare TurnLeftThenTurnRight, mentre gli elementi di dettaglio associati possono fornire specifiche sulle manovre TurnLeft e TurnRight
names	string[]	Strada, autostrada o intersezione in cui si verifica la manovra. Se la manovra è complessa, nella raccolta dei dettagli potrebbero essere presenti più campi nome. Il campo nome potrebbe anche non avere alcun valore. Ciò può verificarsi se il nome non è noto o se una strada, un'autostrada o un'intersezione non ha un nome.
roadType	RoadTypeEnum	Tipo di strada. `Note`: supportato solo per la guida di travelMode.
routePathRange	RoutePathRange	Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.

SubLeg

Object

Informazioni su un segmento dell'itinerario Leg definito dai punti di direzione del percorso e da qualsiasi punto intermedio via strada. Ad esempio, se il percorso Leg ha due punti via via oltre ai punti di partenza e di arrivo, ci sarebbero tre (3) gambe secondarie di percorso.

Nome	Tipo	Descrizione
distanceInMeters	number	Distanza fisica in metri coperti dalla gamba secondaria.
durationInSeconds	integer (int64)	Tempo di viaggio stimato in secondi che non include ritardi sul percorso a causa di condizioni del traffico.
durationTrafficInSeconds	integer (int64)	Tempo necessario, in secondi, per spostarsi in un `TravelDistance` corrispondente con condizioni di traffico correnti. Questo valore viene fornito se `optimizeRoute` include considerazioni sul traffico.
routePathRange	RoutePathRange	Fa riferimento all'intervallo coperto da una gamba specifica di un percorso o di un percorso.

Summary

Object

Riepilogo per la richiesta batch

Nome	Tipo	Descrizione
successfulRequests	integer (int32)	Numero di richieste riuscite nel batch
totalRequests	integer (int32)	Numero totale di richieste nel batch

TrafficCongestionEnum

Enumerazione

Livello di congestione del traffico lungo il percorso. Note: supportato solo per la guida di travelMode

Valore	Descrizione
Heavy	Pesante.
Medium	Medio.
Mild	Lieve.
None	Nessuno.
Unknown	Sconosciuto.

TrafficDataUsedEnum

Enumerazione

Tipo di dati sul traffico in tempo reale usati per generare la route.

Valore	Descrizione
Closure	Dati di chiusura in tempo reale usati, se applicabile.
Flow	Velocità del traffico in tempo reale usate per calcolare il tempo di viaggio.
FlowAndClosure	Flusso e chiusura.
None	Nessuno.

TravelModeEnum

Enumerazione

Modalità di viaggio per il percorso richiesto. Se non definito, il valore predefinito è "guida" che restituisce il percorso ottimizzato per le auto.

Note: per il trasporto di camionMode, il percorso del camion richiesto potrebbe non essere disponibile per l'intero percorso. Se il percorso del camion non è disponibile per una sezione specifica, l'elemento travelMode della risposta per tale sezione sarà "altro".

Esempio: "travelMode":"driving"

Valore	Descrizione
driving	I percorsi restituiti sono ottimizzati per le auto.
truck	I percorsi restituiti sono ottimizzati per autocarri di grandi dimensioni in base alla specifica del veicolo.
walking	I percorsi restituiti sono ottimizzati per i pedoni, incluso l'uso di marciapiedi.

VehicleLoadTypeEnum

Enumerazione

Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta.

Valore	Descrizione
USHazmatClass1	Esplosivi
USHazmatClass2	Gas compresso
USHazmatClass3	Liquidi flammable
USHazmatClass4	Solidi flammable
USHazmatClass5	Ossidanti
USHazmatClass6	Veleni
USHazmatClass7	Radioattivo
USHazmatClass8	Corrosivi
USHazmatClass9	Misto
otherHazmatExplosive	Esplosivi
otherHazmatGeneral	Misto
otherHazmatHarmfulToWater	Dannoso per l'acqua

ViaWaypointProperties

Object

Specifica le proprietà di un ViaWaypoint che è un punto di percorso che deve essere passato o visitato lungo un percorso o un viaggio.

Nome	Tipo	Descrizione
names	string[]	Strada, autostrada o intersezione in cui si verifica la manovra. Se la manovra è complessa, nella raccolta dei dettagli potrebbero essere presenti più campi nome. Il campo nome potrebbe anche non avere alcun valore. Ciò può verificarsi se il nome non è noto o se una strada, un'autostrada o un'intersezione non ha un nome.
order	Order	Sequenza per la visita di waypoint e viaWaypoints.
routePathPoint	RoutePathPoint	Fa riferimento all'indice di un punto all'interno di una gamba specifica di un percorso.
type	string: ViaWaypoint	Tipo di output.

WaypointProperties

Object

Specifica le proprietà di un punto di partenza che è una posizione o un punto specifico lungo un percorso o un viaggio che funge da riferimento o punto di arresto.

Nome	Tipo	Valore predefinito	Descrizione
address	Address		Il distretto amministrativo e l'area geografica del paese per i punti di via e i punti di manovra sul percorso del camion. Nota: supportato solo per truck travelMode.
compassDirection	string		Direzione di viaggio associata a una manovra su un percorso, ad esempio sud o sud-ovest. `Note`: supportato solo per la guida di travelMode.
distanceInMeters	number		Distanza fisica in metri coperti da questo passaggio del percorso.
durationInSeconds	integer (int64)		Tempo necessario, in secondi, per spostarsi in un `TravelDistance`corrispondente.
exitIdentifier	string		Nome o numero dell'uscita associata a questo passaggio di route.
instruction	Instruction		Descrizione di una manovra in un set di direzioni.
order	Order		Sequenza per la visita di waypoint e viaWaypoints.
routePathPoint	RoutePathPoint		Fa riferimento all'indice di un punto all'interno di una gamba specifica di un percorso.
sideOfStreet	SideOfStreetEnum		Il lato della strada in cui si trova la destinazione in base alla direzione di arrivo. Questo campo si applica solo all'ultimo punto di manovra.
signs	string[]		Testo della segnaletica per il percorso. Potrebbero essere presenti più di un valore di segno.
steps	Step[]		Passi tra due punti di manovra consecutivi.
towardsRoadName	string		Nome della strada che il percorso va verso nel primo `ManeuverPoint`.
travelMode	RoutePathTravelModeEnum	driving	Modalità di viaggio per il percorso della risposta.
type	string: Waypoint		Tipo di output.

Condividi tramite

Route - Post Route Directions Batch

Inviare una richiesta batch sincrona

Corpo POST per la richiesta batch

Modello di risposta batch

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

A Route Directions Batch request containing 2 queries

Esempio di richiesta

Risposta di esempio

Definizioni

Address

AdminDistrict

AdminDistrictTruck

AdrTunnelRestrictionCodeEnum

AvoidEnum

CountryRegion

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

DrivingSideEnum

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointProperties

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizedWaypoint

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteDirectionOptimizeRouteEnum

RouteDirectionVehicleSpec

RouteOutputOptionEnum

RoutePathPoint

RoutePathProperties

RoutePathRange

RoutePathTravelModeEnum

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelModeEnum

VehicleLoadTypeEnum

ViaWaypointProperties

WaypointProperties