Route

  • Referens
Service:
Maps
API Version:
1.0

Operations

Get Route Directions

Gäller för prisnivåerna : S0 och S1.

Returnerar en väg mellan ett ursprung och ett mål och passerar genom waypoints om de har angetts. Vägen tar hänsyn till faktorer som aktuell trafik och typiska väghastigheter på den begärda dagen i veckan och tiden på dagen.

Informationen som returneras omfattar avstånd, beräknad restid och en representation av väggeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller turn by turn-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten innehåller en uppsättning parametrar för en detaljerad beskrivning av fordonsspecifik förbrukningsmodell. I Förbrukningsmodell finns en detaljerad förklaring av de begrepp och parametrar som ingår.
Get Route Range

API för vägintervall (Isochrone)

Gäller för prisnivån : S1.

Den här tjänsten beräknar en uppsättning platser som kan nås från ursprungspunkten baserat på den angivna budgeten för bränsle, energi, tid eller avstånd. En polygongräns (eller Isochrone) returneras i en moturs orientering samt det exakta polygoncentret som var resultatet av ursprungspunkten.

Den returnerade polygonen kan användas för ytterligare bearbetning, till exempel Search Inside Geometry, för att söka efter POIs inom den angivna Isochrone.
Post Route Directions

Gäller för prisnivåerna : S0 och S1.

Returnerar en väg mellan ett ursprung och ett mål och passerar genom waypoints om de har angetts. Vägen tar hänsyn till faktorer som aktuell trafik och typiska väghastigheter på den begärda dagen i veckan och tiden på dagen.

Informationen som returneras omfattar avstånd, beräknad restid och en representation av väggeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller turn by turn-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. I Förbrukningsmodell finns en detaljerad förklaring av de begrepp och parametrar som ingår.
Post Route Directions Batch

Batch-API för Route Directions

Gäller för prisnivån : S1.

Batch-API:et Route Directions skickar batchar med frågor till Route Directions API med bara ett enda API-anrop. Du kan anropa Batch API för Route Directions för att antingen köra asynkront (asynkront) eller synkront (synkronisera). Med det asynkrona API:et kan anroparen batcha upp till 700 frågor och synkronisera API:et med upp till 100 frågor.

Skicka synkron batchbegäran

Det synkrona API:et rekommenderas för lätta batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det inte går att hämta resultatet senare. Det synkrona API:et 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}

Skicka en asynkron Batch-begäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa vägbegäranden

  • Det gör det möjligt att hämta resultat i ett separat anrop (flera hämtningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte få någon tidsgräns.
  • 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 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. De asynkrona svaren lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter utgångsperioden.

Observera att asynkron batchbegäran är en långvarig begäran. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Route Directions POST Batch-begäran till Azure Kartor

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

    HTTP 202 Accepted – Batch-begäran har accepterats.

    HTTP Error – Det uppstod ett fel när batchbegäran skulle bearbetas. Detta kan antingen vara 400 Bad Request en eller någon annan Error statuskod.

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

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 Obs!- Kom ihåg att lägga till AUTH-information (subscription-key/azure_auth – Se Säkerhet )till status-URI:n innan du kör den.
4. Klienten skickar en begäran GET om nedladdnings-URL:en som hämtades i steg 3 för att ladda ned batchresultatet.

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

För att skicka frågor om vägriktningar använder du en begäran där begärandetexten innehåller matrisen i format och rubriken POST batchItems anges till json Content-Type application/json . Här är ett exempel på en begärandetext som innehåller 3 vägriktningsfrå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ägriktningsfråga i en batch är bara en partiell URL utan protokoll, bas-URL, sökväg, API-version och prenumerationsnyckel. Den kan acceptera någon av URI-parametrarna för vägriktningarna som stöds. Strängvärdena i vägens directions-fråga måste vara korrekt rymda (t.ex. " tecknet ska vara rymt med ) och det bör också vara \ korrekt URL-kodat.

Med det asynkrona API:et kan anroparen batcha upp till 700 frågor och synkronisera API:et med upp till 100 frågor, och batchen ska innehålla minst 1 fråga.

Ladda ned asynkrona batchresultat

Om du vill ladda ned asynkrona batchresultat utfärdar du GET en begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas Location från rubriken 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 begäran GET 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 asynkrona begäranden och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har bearbetats klart. Det här batchsvaret innehåller en komponent som anger att var en del av den ursprungliga batchbegäran och det vill säga frågor summary totalRequests som har successfulRequests körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItemsinnehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode fälten och response . Varje response in är av någon av följande batchItems typer:

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

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

Här är ett Batch-exempelsvar med ett lyckat och 1 misslyckat 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."
                }
            }
        }
    ]
}
Post Route Matrix

Gäller för prisnivån : S1.

Matrisroutningstjänsten tillåter beräkning av en matris med routningssammanfattningar för en uppsättning vägar som definieras av ursprungs- och målplatser med hjälp av en asynkron (asynkron) eller synkron (synkronisera) POST-begäran. För varje visst ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje givet mål. Uppsättningen ursprung och uppsättningen mål kan ses 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 den cellen. Anta till exempel att ett företag för livsmedelsleverans har 20 drivrutiner och att de måste hitta den närmaste drivrutinen för att kunna hämta leveransen från restaurang. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restider och avstånd. 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 Route Directions-API:et.

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

Skicka begäran om synkron vägmatris

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 för 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 kvadratiskt).

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

Skicka begäran om Asynkron vägmatris

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 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 parametern i begäran är inställd på true får användaren ett 200-svar om begäran har waitForResults slutförts under 120 sekunder.

Den maximala storleken för 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 (den behöver inte vara kvadratisk).

De asynkrona svaren lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter utgångsperioden.

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 ROUTE Matrix POST-begäran till Azure Kartor

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

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

    HTTP Error – Det uppstod ett fel vid bearbetningen av din begäran om vägmatrisen. Detta kan antingen vara en felaktig 400-begäran eller någon annan felstatuskod.

  3. Om matrix route-begäran godkändes innehåller platshuvudet i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:en ser ut så här:

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

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API:et för synkronisering av vägmatris returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det går inte att hämta resultatet senare.

Ladda ned Async-resultat

När en begäran utfärdar 202 Accepted ett 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 platshuvudet för svaret. Den här status-URI:en 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 platshuvudet returnerar följande svar när GET en 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.