Condividi tramite

@azure-rest/maps-route package

  • Riferimento

Interfacce

BatchRequest

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

Oggetto richiesta batch
BatchResultItemOutput

Elemento restituito dall'API Batch. Estendere con la proprietà 'response'.
BatchResultOutput

Questo oggetto viene restituito da una chiamata al servizio Batch riuscita. Estendere con la proprietà 'batchItems'.
BatchResultSummaryOutput

Riepilogo dei risultati per la richiesta batch
EffectiveSettingOutput

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

Dettagli dell'errore.
ErrorResponseOutput

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
GeoJsonFeature

Tipo di oggetto GeoJSON Feature valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonFeatureCollection

Tipo di oggetto GeoJSON FeatureCollection valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Tipo di oggetto GeoJSON GeometryCollection valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Oggetto geometry GeoJSON valido. Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonLineString

Tipo geometry GeoJSON LineString valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonLineStringData
GeoJsonMultiLineString

Tipo geometry GeoJSON MultiLineString valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

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

Dati contenuti da un GeoJson MultiPoint.
GeoJsonMultiPolygon

Tipo di oggetto GeoJSON MultiPolygon valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Oggetto GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPoint

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

Dati contenuti da un GeoJson Point.
GeoJsonPolygon

Tipo geometry GeoJSON Polygon valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Posizione rappresentata come latitudine e longitudine.
MapsRouteClientOptions

Parametri facoltativi per il client
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Inserire i parametri del corpo per le indicazioni stradali.
RouteDirectionsBatchItemOutput

Elemento restituito dalla chiamata al servizio Route Directions Batch.
RouteDirectionsBatchItemResponseOutput

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

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

Questo oggetto viene restituito da una chiamata route directions riuscita
RouteGetRouteDirections200Response

L'API Get Route Directions è una richiesta http GET che restituisce una route tra un'origine e una destinazione, passando i punti di waypoint, se specificato. Il percorso tiene conto di fattori quali il traffico corrente e le velocità tipiche della strada nel giorno richiesto della settimana e dell'ora del giorno.

Le informazioni restituite includono la distanza, il tempo di viaggio stimato e una rappresentazione della geometria del percorso. Sono disponibili anche informazioni aggiuntive sul routing, ad esempio l'ordine dei punti di ottimizzazione o il turno per turno, a seconda delle opzioni selezionate.

Il servizio di routing fornisce un set di parametri per una descrizione dettagliata di un modello di consumo specifico del veicolo. Per altre informazioni, vedere Modello a consumo.
RouteGetRouteDirectionsBatch200Response

L'API è una richiesta http che invia batch di query all'API get route directions tramite una singola richiesta. È possibile chiamare Get Route Directions Batch API per l'esecuzione asincrona (asincrona) o in modo sincrono (sincronizzazione). L'API asincrona consente al chiamante di eseguire il batch fino a 700 query e l'API di sincronizzazione fino a 100 query.

Scaricare i risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata una richiesta di GET all'endpoint di download batch. Questo 'URL di download può essere ottenuto dall'intestazione Location di una richiesta batch di POST riuscita e ha un aspetto simile al seguente:

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

Ecco la sequenza tipica di operazioni per scaricare i risultati del batch:

  1. Il client invia una richiesta di GET usando l'URL di download .

  2. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

    Http 200 OK: richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

L'API è una richiesta http che invia batch di query all'API get route directions tramite una singola richiesta. È possibile chiamare Get Route Directions Batch API per l'esecuzione asincrona (asincrona) o in modo sincrono (sincronizzazione). L'API asincrona consente al chiamante di eseguire il batch fino a 700 query e l'API di sincronizzazione fino a 100 query.

Scaricare i risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata una richiesta di GET all'endpoint di download batch. Questo 'URL di download può essere ottenuto dall'intestazione Location di una richiesta batch di POST riuscita e ha un aspetto simile al seguente:

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

Ecco la sequenza tipica di operazioni per scaricare i risultati del batch:

  1. Il client invia una richiesta di GET usando l'URL di download .

  2. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

    Http 200 OK: richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

L'API Get Route Directions è una richiesta http GET che restituisce una route tra un'origine e una destinazione, passando i punti di waypoint, se specificato. Il percorso tiene conto di fattori quali il traffico corrente e le velocità tipiche della strada nel giorno richiesto della settimana e dell'ora del giorno.

Le informazioni restituite includono la distanza, il tempo di viaggio stimato e una rappresentazione della geometria del percorso. Sono disponibili anche informazioni aggiuntive sul routing, ad esempio l'ordine dei punti di ottimizzazione o il turno per turno, a seconda delle opzioni selezionate.

Il servizio di routing fornisce un set di parametri per una descrizione dettagliata di un modello di consumo specifico del veicolo. Per altre informazioni, vedere Modello a consumo.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

L'API Post Route Directions è una richiesta di POST HTTP che restituisce una route tra un'origine e una destinazione, passando i punti di direzione se specificati. Il percorso tiene conto di fattori quali il traffico corrente e le velocità tipiche della strada nel giorno richiesto della settimana e dell'ora del giorno.

Le informazioni restituite includono la distanza, il tempo di viaggio stimato e una rappresentazione della geometria del percorso. Sono disponibili anche informazioni aggiuntive sul routing, ad esempio l'ordine dei punti di ottimizzazione o il turno per turno, a seconda delle opzioni selezionate.

Il servizio di routing fornisce un set di parametri per una descrizione dettagliata di un modello di consumo specifico del veicolo. Controllare modello a consumo per una spiegazione dettagliata dei concetti e dei parametri coinvolti.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

L'API Post Route Directions è una richiesta di POST HTTP che restituisce una route tra un'origine e una destinazione, passando i punti di direzione se specificati. Il percorso tiene conto di fattori quali il traffico corrente e le velocità tipiche della strada nel giorno richiesto della settimana e dell'ora del giorno.

Le informazioni restituite includono la distanza, il tempo di viaggio stimato e una rappresentazione della geometria del percorso. Sono disponibili anche informazioni aggiuntive sul routing, ad esempio l'ordine dei punti di ottimizzazione o il turno per turno, a seconda delle opzioni selezionate.

Il servizio di routing fornisce un set di parametri per una descrizione dettagliata di un modello di consumo specifico del veicolo. Controllare modello a consumo per una spiegazione dettagliata dei concetti e dei parametri coinvolti.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

L'API Get Route Matrix è una richiesta HTTP GET che calcola il tempo di viaggio e la distanza per tutte le coppie possibili in un elenco di origini e destinazioni. A differenza dell 'API Get Route Directions, che fornisce istruzioni dettagliate sulla route, questa API è incentrata sull'efficienza offrendo il costo (tempo di viaggio e distanza) di routing da ogni origine a ogni destinazione. Per altre informazioni, vedere Procedure consigliate per il servizio di route di Mappe di Azure.

Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta GET matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta GET per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

L'API Get Route Matrix è una richiesta HTTP GET che calcola il tempo di viaggio e la distanza per tutte le coppie possibili in un elenco di origini e destinazioni. A differenza dell 'API Get Route Directions, che fornisce istruzioni dettagliate sulla route, questa API è incentrata sull'efficienza offrendo il costo (tempo di viaggio e distanza) di routing da ogni origine a ogni destinazione. Per altre informazioni, vedere Procedure consigliate per il servizio di route di Mappe di Azure.

Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta GET matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta GET per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteGetRouteRange200Response

L'API Get Route Range (Isochrone) è una richiesta HTTP GET che calcolerà un set di posizioni che è possibile raggiungere dal punto di origine in base al budget di carburante, energia, tempo o distanza specificato. Un limite poligono (o Isocrona) viene restituito in un orientamento antiorario, nonché il centro poligono preciso che era il risultato del punto di origine.

Il poligono restituito può essere usato per un'ulteriore elaborazione, ad esempio ricerca all'interno della geometria per cercare le interfacce POI all'interno della isocrona specificata.
RouteGetRouteRangeDefaultResponse

L'API Get Route Range (Isochrone) è una richiesta HTTP GET che calcolerà un set di posizioni che è possibile raggiungere dal punto di origine in base al budget di carburante, energia, tempo o distanza specificato. Un limite poligono (o Isocrona) viene restituito in un orientamento antiorario, nonché il centro poligono preciso che era il risultato del punto di origine.

Il poligono restituito può essere usato per un'ulteriore elaborazione, ad esempio ricerca all'interno della geometria per cercare le interfacce POI all'interno della isocrona specificata.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

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

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 indicazioni (instructionType=text o tagged), il gruppo di istruzioni ha un messaggio di riepilogo restituito quando disponibile.
RouteInstructionOutput

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

Descrizione di una parte di un itinerario, costituito da un elenco di punti. Ogni punto di percorso aggiuntivo fornito nella richiesta comporterà una gamba aggiuntiva nel percorso restituito.
RouteMatrixOutput

Oggetto risultato matrice
RouteMatrixQuery

Oggetto con una matrice di coordinate.
RouteMatrixResultOutput

Questo oggetto viene restituito da una chiamata di Route Matrix riuscita. Ad esempio, se vengono fornite 2 origini e 3 destinazioni, ci saranno 2 matrici con 3 elementi in ognuno. Il contenuto di ogni elemento dipende dalle opzioni disponibili nella query.
RouteMatrixResultResponseOutput

Oggetto risposta della cella corrente nella matrice di input.
RouteMatrixSummaryOutput

Oggetto Riepilogo
RouteOptimizedWaypointOutput

Oggetto punto di ottimizzazione.
RouteOutput
RouteRangeOutput

Intervallo raggiungibile
RouteRangeResultOutput

Questo oggetto viene restituito da una chiamata Route Reachable Range riuscita
RouteReportOutput

Segnala le impostazioni effettive usate nella chiamata corrente.
RouteRequestRouteDirectionsBatch200Response

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

Inviare una richiesta batch asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di route relativamente complesse

  • Consente il recupero dei risultati in una chiamata separata (sono possibili più download).
  • L'API asincrona è ottimizzata per l'affidabilità e non dovrebbe verificarsi un timeout.
  • Il numero di elementi batch è limitato a 700 per questa API.

Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

Si noti che la richiesta batch asincrona è un'operazione a esecuzione prolungata. Ecco una sequenza tipica di operazioni:

  1. Il client invia una richiesta di route Directions Batch POST a Mappe di Azure.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta batch. Può trattarsi di un 400 Bad Request o di qualsiasi altro codice di stato Error.

  2. Se la richiesta batch è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta batch. Questo URI di stato è simile al seguente:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Il client invia una richiesta di GET nell'URL di download ottenuto nel passaggio 3 per scaricare i risultati del batch.

Corpo POST per la richiesta batch

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

{
    "batchItems": [
        { "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" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Una route directions query in un batch è solo un URL parziale senza il protocollo, l'URL di base, il percorso, la versione api e la chiave di sottoscrizione. Può accettare uno dei parametri URIsupportati indicazioni stradali. I valori stringa nella indicazioni stradali query devono essere preceduti da un carattere di escape corretto (ad esempio, " il carattere deve essere preceduto da un carattere di escape con \ ) e deve anche essere codificato correttamente con URL.

L'API asincrona consente al chiamante di eseguire il batch fino a 700 query e l'API di sincronizzazione fino a 100 query e il batch deve contenere almeno 1 query.

Scaricare i risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata una richiesta di GET all'endpoint di download batch. Questo 'URL di download può essere ottenuto dall'intestazione Location di una richiesta batch di POST riuscita e ha un aspetto simile al seguente:

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

Ecco la sequenza tipica di operazioni per scaricare i risultati del batch:

  1. Il client invia una richiesta di GET usando l'URL di download .

  2. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

    Http 200 OK: richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

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

Inviare una richiesta batch asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di route relativamente complesse

  • Consente il recupero dei risultati in una chiamata separata (sono possibili più download).
  • L'API asincrona è ottimizzata per l'affidabilità e non dovrebbe verificarsi un timeout.
  • Il numero di elementi batch è limitato a 700 per questa API.

Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

Si noti che la richiesta batch asincrona è un'operazione a esecuzione prolungata. Ecco una sequenza tipica di operazioni:

  1. Il client invia una richiesta di route Directions Batch POST a Mappe di Azure.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta batch. Può trattarsi di un 400 Bad Request o di qualsiasi altro codice di stato Error.

  2. Se la richiesta batch è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta batch. Questo URI di stato è simile al seguente:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Il client invia una richiesta di GET nell'URL di download ottenuto nel passaggio 3 per scaricare i risultati del batch.

Corpo POST per la richiesta batch

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

{
    "batchItems": [
        { "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" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Una route directions query in un batch è solo un URL parziale senza il protocollo, l'URL di base, il percorso, la versione api e la chiave di sottoscrizione. Può accettare uno dei parametri URIsupportati indicazioni stradali. I valori stringa nella indicazioni stradali query devono essere preceduti da un carattere di escape corretto (ad esempio, " il carattere deve essere preceduto da un carattere di escape con \ ) e deve anche essere codificato correttamente con URL.

L'API asincrona consente al chiamante di eseguire il batch fino a 700 query e l'API di sincronizzazione fino a 100 query e il batch deve contenere almeno 1 query.

Scaricare i risultati batch asincroni

Per scaricare i risultati del batch asincrono, verrà inviata una richiesta di GET all'endpoint di download batch. Questo 'URL di download può essere ottenuto dall'intestazione Location di una richiesta batch di POST riuscita e ha un aspetto simile al seguente:

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

Ecco la sequenza tipica di operazioni per scaricare i risultati del batch:

  1. Il client invia una richiesta di GET usando l'URL di download .

  2. Il server risponderà con uno dei seguenti elementi:

    HTTP 202 Accepted: la richiesta batch è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

    Http 200 OK: richiesta batch elaborata correttamente. Il corpo della risposta contiene tutti i risultati del batch.

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

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

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/sync/json?api-version=1.0&subscription-key={subscription-key}

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

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

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/sync/json?api-version=1.0&subscription-key={subscription-key}

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

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

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/sync/json?api-version=1.0&subscription-key={subscription-key}

Modello di risposta batch

Il contenuto dei dati restituito è simile per le richieste asincrone e di sincronizzazione. Quando si scaricano i risultati di una richiesta batch asincrona, se il batch ha terminato l'elaborazione, il corpo della risposta contiene la risposta batch. Questa risposta batch contiene un componente summary che indica il totalRequests che fanno parte della richiesta batch originale e successfulRequestsad 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 in batchItems contiene campi statusCode e response. Ogni response in batchItems è di uno dei tipi seguenti:

  • RouteDirections: se la query è stata completata correttamente.

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

Di seguito è riportato un esempio di risposta batch con 1 riuscito 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

L'API Post Route Matrix è una richiesta http POST che consente il calcolo di una matrice di riepiloghi di route per un set di route definite dalle posizioni di origine e di destinazione usando una richiesta asincrona (asincrona). Per effettuare una richiesta sincrona (sincrona), vedere Post Route Matrix Sync. Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Nota

Tutte le origini e le destinazioni devono essere contenute in un rettangolo delimitatore di 400 km x 400 km. In caso contrario, alcune celle della matrice verranno risolte come OUT_OF_REGION.

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

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

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta POST matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta POST per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

L'API Post Route Matrix è una richiesta http POST che consente il calcolo di una matrice di riepiloghi di route per un set di route definite dalle posizioni di origine e di destinazione usando una richiesta asincrona (asincrona). Per effettuare una richiesta sincrona (sincrona), vedere Post Route Matrix Sync. Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Nota

Tutte le origini e le destinazioni devono essere contenute in un rettangolo delimitatore di 400 km x 400 km. In caso contrario, alcune celle della matrice verranno risolte come OUT_OF_REGION.

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

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

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta POST matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta POST per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

L'API Post Route Matrix Sync è una richiesta HTTP POST che consente il calcolo di una matrice di riepiloghi di route per un set di route definite dalle posizioni di origine e di destinazione usando una singola richiesta sincrona (sincrona). Per effettuare una richiesta asincrona (asincrona), vedere Post Route Matrix. Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

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

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta POST matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta POST per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteRequestRouteMatrixSync408Response

L'API Post Route Matrix Sync è una richiesta HTTP POST che consente il calcolo di una matrice di riepiloghi di route per un set di route definite dalle posizioni di origine e di destinazione usando una singola richiesta sincrona (sincrona). Per effettuare una richiesta asincrona (asincrona), vedere Post Route Matrix. Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

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

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta POST matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta POST per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

L'API Post Route Matrix Sync è una richiesta HTTP POST che consente il calcolo di una matrice di riepiloghi di route per un set di route definite dalle posizioni di origine e di destinazione usando una singola richiesta sincrona (sincrona). Per effettuare una richiesta asincrona (asincrona), vedere Post Route Matrix. Per ogni origine specificata, il servizio calcola il costo del routing da tale origine a ogni destinazione specificata. Il set di origini e il set di destinazioni possono essere considerati come le intestazioni di colonna e riga di una tabella e ogni cella della tabella contiene i costi di routing dall'origine alla destinazione per tale cella. Ad esempio, si supponga che un'azienda di consegna alimentare abbia 20 conducenti e che debbano trovare il conducente più vicino per prendere la consegna dal ristorante. Per risolvere questo caso d'uso, è possibile chiamare l'API Route matrix.

Per ogni itinerario, vengono restituiti i tempi di viaggio e le distanze. È possibile usare i costi calcolati per determinare quali route dettagliate calcolare usando l'API Indicazioni stradali.

La dimensione massima di una matrice per una richiesta asincrona è 700 e per la richiesta di sincronizzazione è 100 (il numero di origini moltiplicato per il numero di destinazioni).

Invia richiesta matrice di route sincrona

Se lo scenario richiede richieste sincrone e la dimensione massima della matrice è minore o uguale a 100, potrebbe essere necessario effettuare una richiesta sincrona. La dimensione massima di una matrice per questa API è 100 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 10x10, 6x8, 9x8 (non deve essere quadrato).

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

Invia richiesta matrice di route asincrona

L'API asincrona è appropriata per l'elaborazione di grandi volumi di richieste di routing relativamente complesse. Quando si effettua una richiesta usando una richiesta asincrona, per impostazione predefinita il servizio restituisce un codice di risposta 202 lungo un URL di reindirizzamento nel campo Percorso dell'intestazione della risposta. Questo URL deve essere controllato periodicamente fino a quando non sono disponibili i dati di risposta o le informazioni sull'errore. Se waitForResults parametro nella richiesta è impostato su true, l'utente riceverà una risposta 200 se la richiesta viene completata in meno di 120 secondi.

La dimensione massima di una matrice per questa API è 700 (il numero di origini moltiplicato per il numero di destinazioni). Tenendo presente tale vincolo, alcuni esempi di possibili dimensioni della matrice sono: 50x10, 10x10, 28x25. 10x70 (non deve essere quadrato).

Le risposte asincrone vengono archiviate per 24 ore. L'URL di reindirizzamento restituisce una risposta 404 se usata dopo il periodo di scadenza.

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

Ecco una sequenza tipica di operazioni asincrone:

  1. Il client invia una richiesta POST matrice di route a Mappe di Azure

  2. Il server risponderà con uno dei seguenti elementi:

    Http 202 Accepted - Richiesta matrice di route accettata.

    HTTP Error: si è verificato un errore durante l'elaborazione della richiesta matrice di route. Potrebbe trattarsi di una richiesta non valida 400 o di qualsiasi altro codice di stato errore.

  3. Se la richiesta di route matrice è stata accettata correttamente, l'intestazione Location nella risposta contiene l'URL per scaricare i risultati della richiesta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Il client invia una richiesta GET sull'URL di download ottenuto nel passaggio 3 per scaricare i risultati

Scaricare i risultati della sincronizzazione

Quando si effettua una richiesta POST per l'API di sincronizzazione matrice di route, il servizio restituisce il codice di risposta 200 per la richiesta riuscita e una matrice di risposte. Il corpo della risposta conterrà i dati e non sarà possibile recuperare i risultati in un secondo momento.

Scaricare i risultati asincroni

Quando una richiesta invia una risposta 202 Accepted, la richiesta viene elaborata usando la pipeline asincrona. Verrà assegnato un URL per controllare lo stato di avanzamento della richiesta asincrona nell'intestazione del percorso della risposta. Questo URI di stato è simile al seguente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L'URL fornito dall'intestazione della posizione restituirà le risposte seguenti quando viene emessa una richiesta di GET.

HTTP 202 Accepted: la richiesta matrice è stata accettata ma è ancora in corso di elaborazione. Riprovare in qualche tempo.

HTTP 200 OK: la richiesta di matrice è stata elaborata correttamente. Il corpo della risposta contiene tutti i risultati.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

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

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

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

Oggetto Riepilogo
Routes
SimplePollerLike

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

Alias tipo

GeoJsonGeometry

Oggetto geometry GeoJSON valido. Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonObject

Oggetto GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funzioni

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Creare un corpo della richiesta batch di un gruppo di richieste di direzione di route.
default(AzureKeyCredential, ClientOptions)

Crea un'istanza di MapsRouteClient da una chiave di sottoscrizione.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Crea un'istanza di MapsRoute da un'identità di Azure TokenCredential.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Crea un'istanza di MapsRoute da un'identità di Azure AzureSASCredential.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Funzione helper che compila un oggetto Poller per consentire il polling di un'operazione a esecuzione prolungata.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Trasformare una matrice di [Latitude, Longtitute] in una stringa nel formato seguente: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Dettagli funzione

buildMultiCollection(string[], string) 

function buildMultiCollection(items: string[], parameterName: string): string

Parametri

items

string[]

parameterName

string

Restituisce

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Creare un corpo della richiesta batch di un gruppo di richieste di direzione di route.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parametri

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Oggetto dei parametri di query per una richiesta di direzione della route

Restituisce

BatchRequest

Richiesta batch composta.

default(AzureKeyCredential, ClientOptions)

Crea un'istanza di MapsRouteClient da una chiave di sottoscrizione.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Parametri

credential
AzureKeyCredential

Istanza di AzureKeyCredential usata per autenticare le richieste al servizio

options
ClientOptions

Opzioni usate per configurare il client di route

Restituisce

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Crea un'istanza di MapsRoute da un'identità di Azure TokenCredential.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Parametri

credential
TokenCredential

Istanza tokenCredential usata per autenticare le richieste al servizio

mapsAccountClientId

string

ID client di Mappe di Azure di una risorsa mappa specifica

options
ClientOptions

Opzioni usate per configurare il client di route

Restituisce

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Crea un'istanza di MapsRoute da un'identità di Azure AzureSASCredential.

Esempio

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Parametri

credential
AzureSASCredential

Istanza di AzureSASCredential usata per autenticare le richieste al servizio

options
ClientOptions

Opzioni usate per configurare il client di route

Restituisce

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Funzione helper che compila un oggetto Poller per consentire il polling di un'operazione a esecuzione prolungata.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parametri

client
Client

Client da usare per inviare la richiesta per ottenere pagine aggiuntive.

initialResponse

TResult

Risposta iniziale.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opzioni per impostare uno stato di ripresa o un intervallo di polling personalizzato.

Restituisce

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Oggetto poller per eseguire il polling degli aggiornamenti dello stato dell'operazione e infine ottenere la risposta finale.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parametri

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Restituisce

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parametri

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Restituisce

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parametri

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Restituisce

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parametri

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Restituisce

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parametri

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Restituisce

response

toColonDelimitedLatLonString(LatLon[])

Trasformare una matrice di [Latitude, Longtitute] in una stringa nel formato seguente: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parametri

coordinates

LatLon[]

Matrice di coppie Latitude/Longtitute da trasformare.

Restituisce

string

Stringa trasformata.