Dela via

@azure-rest/maps-route package

  • Referens

Gränssnitt

BatchRequest

Den här typen representerar begärandetexten för Batch-tjänsten.
BatchRequestItem

Batch-begärandeobjekt
BatchResultItemOutput

Ett objekt som returneras från Batch API. Utöka med egenskapen "response".
BatchResultOutput

Det här objektet returneras från ett lyckat Batch-tjänstanrop. Utöka med egenskapen "batchItems".
BatchResultSummaryOutput

Sammanfattning av resultatet för batchbegäran
EffectiveSettingOutput

Effektiv parameter eller data som används när du anropar det här routnings-API:et.
ErrorDetailOutput

Felinformationen.
ErrorResponseOutput

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
GeoJsonFeature

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946.
GeoJsonFeatureCollection

En giltig GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946.
GeoJsonLineStringData
GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiPointData

Data som finns i en GeoJson MultiPoint.
GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Ett giltigt GeoJSON objekt. Mer information finns i RFC 7946.
GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.
GeoJsonPointData

Data som finns i en GeoJson Point.
GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

En plats som representeras som latitud och longitud.
MapsRouteClientOptions

Valfria parametrar för klienten
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Publicera brödtextparametrar för vägbeskrivningar.
RouteDirectionsBatchItemOutput

Ett objekt som returneras från Routningsriktningar Batch-tjänstanrop.
RouteDirectionsBatchItemResponseOutput

Resultatet av frågan. RouteDirections om frågan har slutförts, annars ErrorResponse.
RouteDirectionsBatchResultOutput

Det här objektet returneras från ett lyckat Route Directions Batch-tjänstanrop.
RouteDirectionsOutput

Det här objektet returneras från ett lyckat Vägbeskrivningsanrop
RouteGetRouteDirections200Response

Get Route Directions-API:et är en HTTP-GET begäran som returnerar en väg mellan ett ursprung och ett mål som passerar genom vägpunkter om det anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda veckodagen och tiden på dagen.

Informationen som returneras omfattar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av en fordonsspecifik förbrukningsmodell. Mer information finns i förbrukningsmodell.
RouteGetRouteDirectionsBatch200Response

Get Route Directions Batch-API:et är en HTTP-GET begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda begäran. Du kan anropa Get Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor.

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat utfärdar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från Location-huvudet för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran godkändes men bearbetas fortfarande. Försök igen om en stund.

    HTTP-200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Get Route Directions Batch-API:et är en HTTP-GET begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda begäran. Du kan anropa Get Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor.

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat utfärdar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från Location-huvudet för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran godkändes men bearbetas fortfarande. Försök igen om en stund.

    HTTP-200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Get Route Directions-API:et är en HTTP-GET begäran som returnerar en väg mellan ett ursprung och ett mål som passerar genom vägpunkter om det anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda veckodagen och tiden på dagen.

Informationen som returneras omfattar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av en fordonsspecifik förbrukningsmodell. Mer information finns i förbrukningsmodell.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Post Route Directions-API:et är en HTTP-POST begäran som returnerar en väg mellan ett ursprung och ett mål och som passerar genom vägpunkter om de anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda dagen i veckan och tiden på dagen.

Informationen som returneras omfattar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av en fordonsspecifik förbrukningsmodell. Mer information om begrepp och parametrar finns i förbrukningsmodell.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Post Route Directions-API:et är en HTTP-POST begäran som returnerar en väg mellan ett ursprung och ett mål och som passerar genom vägpunkter om de anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda dagen i veckan och tiden på dagen.

Informationen som returneras omfattar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av en fordonsspecifik förbrukningsmodell. Mer information om begrepp och parametrar finns i förbrukningsmodell.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Get Route Matrix-API:et är en HTTP-GET begäran som beräknar restiden och avståndet för alla möjliga par i en lista över ursprung och mål. Till skillnad från Get Route Directions API, som tillhandahåller detaljerade väginstruktioner, fokuserar detta API på effektivitet genom att ge dig kostnaden (restid och avstånd) för routning från varje ursprung till varje mål. Mer information finns i Metodtips för Azure Maps Route-tjänsten.

För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en GET-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en GET-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Get Route Matrix-API:et är en HTTP-GET begäran som beräknar restiden och avståndet för alla möjliga par i en lista över ursprung och mål. Till skillnad från Get Route Directions API, som tillhandahåller detaljerade väginstruktioner, fokuserar detta API på effektivitet genom att ge dig kostnaden (restid och avstånd) för routning från varje ursprung till varje mål. Mer information finns i Metodtips för Azure Maps Route-tjänsten.

För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en GET-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en GET-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteGetRouteRange200Response

API:et Get Route Range (Isochrone) är en HTTP-GET begäran som beräknar en uppsättning platser som kan nås från ursprungspunkten baserat på bränsle, energi, tid eller avståndsbudget som anges. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten.

Den returnerade polygonen kan användas för vidare bearbetning, till exempel Sök inuti geometri för att söka efter POIs inom den angivna isochronen.
RouteGetRouteRangeDefaultResponse

API:et Get Route Range (Isochrone) är en HTTP-GET begäran som beräknar en uppsättning platser som kan nås från ursprungspunkten baserat på bränsle, energi, tid eller avståndsbudget som anges. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten.

Den returnerade polygonen kan användas för vidare bearbetning, till exempel Sök inuti geometri för att söka efter POIs inom den angivna isochronen.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.
RouteInstructionGroupOutput

Grupperar en sekvens med instruktionselement som är relaterade till varandra. Sekvensintervallet är begränsat med firstInstructionIndex och lastInstructionIndex. När textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggade) har instruktionsgruppen ett sammanfattningsmeddelande som returneras när det är tillgängligt.
RouteInstructionOutput

En uppsättning attribut som beskriver en manöver, t.ex. "Sväng höger", "Håll vänster", "Ta färjan", "Ta motorvägen", "Anländer".
RouteLegOutput

En beskrivning av en del av en väg, som består av en lista över punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.
RouteMatrixOutput

Matrisresultatobjekt
RouteMatrixQuery

Ett objekt med en matris med koordinater.
RouteMatrixResultOutput

Det här objektet returneras från ett lyckat Routningsmatrisanrop. Om till exempel 2 ursprung och 3 mål tillhandahålls, finns det 2 matriser med 3 element i varje. Varje elements innehåll beror på vilka alternativ som anges i frågan.
RouteMatrixResultResponseOutput

Svarsobjekt för den aktuella cellen i indatamatrisen.
RouteMatrixSummaryOutput

Sammanfattningsobjekt
RouteOptimizedWaypointOutput

Optimerat vägpunktsobjekt.
RouteOutput
RouteRangeOutput

Räckviddsbart intervall
RouteRangeResultOutput

Det här objektet returneras från ett lyckat routningsbart intervallanrop
RouteReportOutput

Rapporterar de effektiva inställningar som används i det aktuella anropet.
RouteRequestRouteDirectionsBatch200Response

Post Route Directions Batch-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda asynkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Om du vill anropa Post Route Directions Batch-API:et i en synkron begäran kan du läsa Batch-synkronisering efter vägbeskrivningar.

Skicka asynkron Batch-begäran

Asynkront API är lämpligt för bearbetning av stora volymer av relativt komplexa routningsbegäranden

  • Det gör det möjligt att hämta resultat i ett separat anrop (flera nedladdningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte överskrida tidsgränsen.
  • Antalet batchobjekt är begränsat till 700 för det här API:et.

När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

Observera att en asynkron batchbegäran är en tidskrävande åtgärd. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Route Directions Batch-POST begäran till Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran har godkänts.

    HTTP-Error – Det uppstod ett fel vid bearbetning av Batch-begäran. Detta kan antingen vara en 400 Bad Request eller någon annan Error statuskod.

  2. Om batchbegäran godkändes innehåller Location-huvudet i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:n ser ut så här:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klienten utfärdar en GET begäran om nedladdnings-URL hämtas i steg 3 för att ladda ned batchresultatet.

POST-brödtext för Batch-begäran

Om du vill skicka vägbeskrivningar frågor använder du en POST begäran där begärandetexten innehåller batchItems matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 3 vägbeskrivningar frågor:

{
    "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" }
    ]
}

En vägbeskrivningar fråga i en batch är bara en partiell URL-utan protokollet, bas-URL:en, sökvägen, api-versionen och prenumerationsnyckeln. Den kan acceptera någon av de vägbeskrivningar som stödsURI-parametrar. Strängvärdena i vägbeskrivningar frågan måste vara korrekt undantagna (t.ex. " tecknet ska vara undantaget med \ ) och det bör också vara korrekt URL-kodat.

Med api:et async kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor, och batchen bör innehålla minst 1 fråga.

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat utfärdar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från Location-huvudet för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran godkändes men bearbetas fortfarande. Försök igen om en stund.

    HTTP-200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Post Route Directions Batch-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda asynkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Om du vill anropa Post Route Directions Batch-API:et i en synkron begäran kan du läsa Batch-synkronisering efter vägbeskrivningar.

Skicka asynkron Batch-begäran

Asynkront API är lämpligt för bearbetning av stora volymer av relativt komplexa routningsbegäranden

  • Det gör det möjligt att hämta resultat i ett separat anrop (flera nedladdningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte överskrida tidsgränsen.
  • Antalet batchobjekt är begränsat till 700 för det här API:et.

När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

Observera att en asynkron batchbegäran är en tidskrävande åtgärd. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Route Directions Batch-POST begäran till Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran har godkänts.

    HTTP-Error – Det uppstod ett fel vid bearbetning av Batch-begäran. Detta kan antingen vara en 400 Bad Request eller någon annan Error statuskod.

  2. Om batchbegäran godkändes innehåller Location-huvudet i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:n ser ut så här:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klienten utfärdar en GET begäran om nedladdnings-URL hämtas i steg 3 för att ladda ned batchresultatet.

POST-brödtext för Batch-begäran

Om du vill skicka vägbeskrivningar frågor använder du en POST begäran där begärandetexten innehåller batchItems matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 3 vägbeskrivningar frågor:

{
    "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" }
    ]
}

En vägbeskrivningar fråga i en batch är bara en partiell URL-utan protokollet, bas-URL:en, sökvägen, api-versionen och prenumerationsnyckeln. Den kan acceptera någon av de vägbeskrivningar som stödsURI-parametrar. Strängvärdena i vägbeskrivningar frågan måste vara korrekt undantagna (t.ex. " tecknet ska vara undantaget med \ ) och det bör också vara korrekt URL-kodat.

Med api:et async kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor, och batchen bör innehålla minst 1 fråga.

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat utfärdar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från Location-huvudet för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP-202 Accepted – Batch-begäran godkändes men bearbetas fortfarande. Försök igen om en stund.

    HTTP-200 OK – Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Post Route Directions Batch Sync-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda synkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Information om hur du anropar Post Route Directions Batch-API:et i en asynkron begäran finns i Batchpostrouteriktningar .

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Post Route Directions Batch Sync-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda synkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Information om hur du anropar Post Route Directions Batch-API:et i en asynkron begäran finns i Batchpostrouteriktningar .

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Post Route Directions Batch Sync-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda synkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Information om hur du anropar Post Route Directions Batch-API:et i en asynkron begäran finns i Batchpostrouteriktningar .

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Post Route Matrix-API:et är en HTTP-POST begäran som tillåter beräkning av en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en asynkron (asynkron) begäran. Om du vill göra en synkron (synkron) begäran kan du läsa Synkronisering efter routningsmatris. För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Obs!

Alla ursprung och mål ska finnas i en axeljusterad avgränsningsruta på 400 km x 400 km. Annars löses vissa matrisceller som OUT_OF_REGION.

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Post Route Matrix-API:et är en HTTP-POST begäran som tillåter beräkning av en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en asynkron (asynkron) begäran. Om du vill göra en synkron (synkron) begäran kan du läsa Synkronisering efter routningsmatris. För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Obs!

Alla ursprung och mål ska finnas i en axeljusterad avgränsningsruta på 400 km x 400 km. Annars löses vissa matrisceller som OUT_OF_REGION.

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Post Route Matrix Sync-API:et är en HTTP-POST begäran som gör det möjligt att beräkna en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en enda synkron (synkron) begäran. Information om hur du gör en asynkron begäran (asynkron) finns i . För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteRequestRouteMatrixSync408Response

Post Route Matrix Sync-API:et är en HTTP-POST begäran som gör det möjligt att beräkna en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en enda synkron (synkron) begäran. Information om hur du gör en asynkron begäran (asynkron) finns i . För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Post Route Matrix Sync-API:et är en HTTP-POST begäran som gör det möjligt att beräkna en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en enda synkron (synkron) begäran. Information om hur du gör en asynkron begäran (asynkron) finns i . För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen startPointIndex, endPointIndexoch sectionType.
RouteSectionTecCauseOutput

Orsaken till trafikhändelsen. Kan innehålla mainCauseCode- och subCauseCode-element. Kan användas för att definiera ikonografi och beskrivningar.
RouteSectionTecOutput

Information om trafikhändelsen med hjälp av definitioner i TPEG2-TEC- standard. Kan innehålla effectCode och orsakar element.
RouteSummaryOutput

Sammanfattningsobjekt
Routes
SimplePollerLike

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

Typalias

GeoJsonGeometry

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
GeoJsonObject

Ett giltigt GeoJSON objekt. Mer information finns i RFC 7946.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funktioner

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

Skapa en batchbegärandetext med en mängd begäranden om vägriktning.
default(AzureKeyCredential, ClientOptions)

Skapar en instans av MapsRouteClient från en prenumerationsnyckel.

Exempel

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)

Skapar en instans av MapsRoute från en Azure Identity-TokenCredential.

Exempel

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)

Skapar en instans av MapsRoute från en Azure Identity-AzureSASCredential.

Exempel

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

Hjälpfunktionen som skapar ett Poller-objekt för att avsöka en tidskrävande åtgärd.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transformera en matris med [Latitud, Longtitute] till en sträng i följande format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Funktionsinformation

buildMultiCollection(string[], string) 

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

Parametrar

items

string[]

parameterName

string

Returer

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Skapa en batchbegärandetext med en mängd begäranden om vägriktning.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parametrar

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Ett objekt i frågeparametrarna för en begäran om vägriktning

Returer

BatchRequest

Den sammansatta batchbegäran.

default(AzureKeyCredential, ClientOptions)

Skapar en instans av MapsRouteClient från en prenumerationsnyckel.

Exempel

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

Parametrar

credential
AzureKeyCredential

En AzureKeyCredential-instans som används för att autentisera begäranden till tjänsten

options
ClientOptions

Alternativ som används för att konfigurera routningsklienten

Returer

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Skapar en instans av MapsRoute från en Azure Identity-TokenCredential.

Exempel

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

Parametrar

credential
TokenCredential

En TokenCredential-instans som används för att autentisera begäranden till tjänsten

mapsAccountClientId

string

Azure Maps-klient-ID för en specifik kartresurs

options
ClientOptions

Alternativ som används för att konfigurera routningsklienten

Returer

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Skapar en instans av MapsRoute från en Azure Identity-AzureSASCredential.

Exempel

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

Parametrar

credential
AzureSASCredential

En AzureSASCredential-instans som används för att autentisera begäranden till tjänsten

options
ClientOptions

Alternativ som används för att konfigurera routningsklienten

Returer

MapsRouteClient

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

Hjälpfunktionen som skapar ett Poller-objekt för att avsöka en tidskrävande åtgärd.

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

Parametrar

client
Client

Klienten som ska användas för att skicka begäran för att hämta ytterligare sidor.

initialResponse

TResult

Det första svaret.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Alternativ för att ange ett cv-tillstånd eller anpassat avsökningsintervall.

Returer

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

  • Ett pollerobjekt som ska avsökas efter åtgärdstillståndsuppdateringar och slutligen få det slutliga svaret.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

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

Parametrar

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Returer

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parametrar

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Returer

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parametrar

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Returer

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parametrar

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Returer

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

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

Parametrar

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Returer

response

toColonDelimitedLatLonString(LatLon[])

Transformera en matris med [Latitud, Longtitute] till en sträng i följande format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parametrar

coordinates

LatLon[]

En matris med latitude/longtitute-par som ska transformeras.

Returer

string

Den transformerade strängen.