Route - Post Route Directions Batch

Referens

Service:: Maps

API Version:: 1.0

Använd för att skicka en batch med frågor till API:et Get Route Directions i en enda asynkron begäran.

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

Skicka asynkron Batch-begäran

Det asynkrona API:et ä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 async-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 förfalloperioden.

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

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

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

Servern svarar med något av följande:

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

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.
Om batchbegäran godkändes Location innehåller rubriken 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}

Klienten utfärdar en GET begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned batchresultatet.

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

Om du vill skicka vägbeskrivningsfrågor använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type rubriken anges till application/json. Här är ett exempel på en begärandetext som innehåller tre vägbeskrivningsfrå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ägbeskrivningsfrå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 routningsriktningar som stöds. Strängvärdena i routningsriktningsfrågan måste vara korrekt undantagna (t.ex. " tecken ska vara undantagna 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 med 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 skickar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från rubriken för Location 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:

Klienten skickar en GET begäran med hjälp av nedladdnings-URL:en.
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 asynkronisering 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 vilka som ingick i den ursprungliga batchbegäran, dvs successfulRequests. frågor som har körts korrekt. Batchsvaret 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 in 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 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 https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

Name	Typ	Description
batchItems	BatchRequestItem[]	Listan över frågor som ska bearbetas.

Svar

Name	Typ	Description
200 OK	RouteDirectionsBatchResult	Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.
202 Accepted		Stöds endast för asynkron begäran. Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i platsrubriken för att försöka igen eller komma åt resultatet. Headers Location: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Name

Typ

Description

200 OK

RouteDirectionsBatchResult

Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.

202 Accepted

Stöds endast för asynkron begäran. Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i platsrubriken för att försöka igen eller komma åt resultatet.

Headers

Location: string

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps konto i Azure Portal eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully submit a route direction batch request

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

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

Status code:: 202

operation-Location: URL to download the results of the long-running batch request.

Definitioner

Name	Description
BatchRequest	Den här typen representerar begärandetexten för Batch-tjänsten.
BatchRequestItem	Batch-begärandeobjekt
DelayMagnitude	Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältets ty i API:et Hämta information om trafikincidenter.
DrivingSide	Anger vänster jämfört med höger sida som kör vid manöverpunkten.
EffectiveSetting	Effektiv parameter eller data som används vid anrop av det här routnings-API:et.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GuidanceInstructionType	Typ av instruktion, t.ex. sväng eller ändring av vägformulär.
GuidanceManeuver	En kod som identifierar manövern.
JsonFormat	Önskat format för svaret. Endast `json` format stöds.
JunctionType	Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.
LatLongPair	En plats som representeras som latitud och longitud.
Response	Resultatet av frågan. RouteDirections om frågan har slutförts, ErrorResponse annars.
ResponseSectionType	Avsnittstyper för det rapporterade vägsvaret
ResponseTravelMode	Reseläge för den beräknade rutten. Värdet anges till `other` om det begärda transportsättet inte är möjligt i det här avsnittet
Route
RouteDirectionsBatchItem	Ett objekt som returneras från Route Directions Batch-tjänstanropet.
RouteDirectionsBatchResult	Det här objektet returneras från ett lyckat Route Directions Batch-tjänstanrop.
RouteGuidance	Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.
RouteInstruction	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", "Ankomma".
RouteInstructionGroup	Grupper 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 instructionGroup ett sammanfattningsmeddelande som returneras när det är tillgängligt.
RouteLeg	En beskrivning av en del av en väg, som består av en lista med punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.
RouteLegSummary	Sammanfattningsobjekt för vägavsnitt.
RouteOptimizedWaypoint	Optimerat vägpunktsobjekt.
RouteReport	Rapporterar de gällande inställningarna som används i det aktuella anropet.
RouteSection	Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen `startPointIndex`, `endPointIndex`och `sectionType`.
RouteSectionTec	Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.
RouteSectionTecCause	Orsaken till trafikhändelsen. Kan innehålla mainCauseCode- och subCauseCode-element. Kan användas för att definiera ikonografi och beskrivningar.
RouteSummary	Sammanfattningsobjekt
SimpleCategory	Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".
Summary	Sammanfattning av resultatet för batchbegäran

BatchRequest

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

Name	Typ	Description
batchItems	BatchRequestItem[]	Listan över frågor som ska bearbetas.

BatchRequestItem

Batch-begärandeobjekt

Name	Typ	Description
query	string	Den här parametern innehåller en frågesträng som används för att utföra en ostrukturerad geokodningsåtgärd. Frågesträngen skickas ordagrant till sök-API:et för bearbetning.

DelayMagnitude

Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältets ty i API:et Hämta information om trafikincidenter.

Name	Typ	Description
0	string	Okänt.
1	string	Mindre.
2	string	Medel.
3	string	Stora.
4	string	Odefinierat, används för vägavstängningar och andra obestämda förseningar.

DrivingSide

Anger vänster jämfört med höger sida som kör vid manöverpunkten.

Name	Typ	Description
LEFT	string	Vänster.
RIGHT	string	Höger sida.

EffectiveSetting

Effektiv parameter eller data som används vid anrop av det här routnings-API:et.

Name	Typ	Description
key	string	Namnet på parametern som används.
value	string	Värdet för den parameter som används.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägformulär.

Name	Typ	Description
DIRECTION_INFO	string	Riktningsinformation.
LOCATION_ARRIVAL	string	Ankomstplats.
LOCATION_DEPARTURE	string	Avgångsplats.
LOCATION_WAYPOINT	string	Plats för vägpunkt.
ROAD_CHANGE	string	Vägändring.
TURN	string	Vända.

GuidanceManeuver

En kod som identifierar manövern.

Name	Typ	Description
ARRIVE	string	Du har kommit.
ARRIVE_LEFT	string	Du har kommit. Målet är till vänster.
ARRIVE_RIGHT	string	Du har kommit. Målet är till höger.
BEAR_LEFT	string	Björn vänster.
BEAR_RIGHT	string	Ha rätt.
DEPART	string	Lämna.
ENTER_FREEWAY	string	Ta motorvägen.
ENTER_HIGHWAY	string	Ta motorvägen.
ENTER_MOTORWAY	string	Ta motorvägen.
ENTRANCE_RAMP	string	Ta rampen.
FOLLOW	string	Följa.
KEEP_LEFT	string	Håll till vänster.
KEEP_RIGHT	string	Håll dig till höger.
MAKE_UTURN	string	Gör en U-sväng.
MOTORWAY_EXIT_LEFT	string	Ta vänster utgång.
MOTORWAY_EXIT_RIGHT	string	Ta höger utgång.
ROUNDABOUT_BACK	string	Gå runt rondellen.
ROUNDABOUT_CROSS	string	Korsa rondellen.
ROUNDABOUT_LEFT	string	I rondellen tar du avfarten till vänster.
ROUNDABOUT_RIGHT	string	Vid rondellen tar du avfarten till höger.
SHARP_LEFT	string	Vrid vasst åt vänster.
SHARP_RIGHT	string	Sväng skarp höger.
STRAIGHT	string	Håll dig rakt på.
SWITCH_MAIN_ROAD	string	Växla till huvudvägen.
SWITCH_PARALLEL_ROAD	string	Växla till den parallella vägen.
TAKE_EXIT	string	Ta avslutet.
TAKE_FERRY	string	Ta färjan.
TRY_MAKE_UTURN	string	Försök att göra en U-sväng.
TURN_LEFT	string	Sväng vänster.
TURN_RIGHT	string	Sväng höger.
WAYPOINT_LEFT	string	Du har nått vägpunkten. Det är till vänster.
WAYPOINT_REACHED	string	Du har nått vägpunkten.
WAYPOINT_RIGHT	string	Du har nått vägpunkten. Det är till höger.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

JunctionType

Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

Name	Typ	Description
BIFURCATION	string	Bifurkation
REGULAR	string	Regelbundna
ROUNDABOUT	string	Rondellen

LatLongPair

En plats som representeras som latitud och longitud.

Name	Typ	Description
latitude	number	Latitude-egenskap
longitude	number	Longitudegenskap

Response

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

Name	Typ	Description
error	ErrorDetail	Felobjektet.
formatVersion	string	Formatversionsegenskap
optimizedWaypoints	RouteOptimizedWaypoint[]	Optimerad sekvens med waypoints. Den visar indexet från den användardefinierade waypoint-sekvensen för den ursprungliga och optimerade listan. Till exempel ett svar: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` innebär att den ursprungliga sekvensen är [0, 1, 2] och optimerad sekvens är [1, 2, 0]. Eftersom indexet börjar med 0 är originalet "första, andra, tredje" medan det optimerade är "second, third, first".
report	RouteReport	Rapporterar de gällande inställningarna som används i det aktuella anropet.
routes	Route[]	Routningsmatris

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

Name	Typ	Description
CARPOOL	string	Delar av rutten som kräver användning av samåkningsfiler (HOV/High Occupancy Vehicle).
CAR_TRAIN	string	Delar av rutten som är bilar eller tåg.
COUNTRY	string	Avsnitt som anger vilka länder/regioner som rutten finns i.
FERRY	string	Delar av rutten som är färjor.
MOTORWAY	string	Delar av rutten som är motorvägar.
PEDESTRIAN	string	Delar av rutten som endast lämpar sig för fotgängare.
TOLL_ROAD	string	Delar av rutten som kräver en avgift som ska betalas.
TOLL_VIGNETTE	string	Delar av rutten som kräver en avgiftsbelagd vinjett för att finnas.
TRAFFIC	string	Delar av vägen som innehåller trafikinformation.
TRAVEL_MODE	string	Avsnitt i förhållande till parametern `travelMode`request .
TUNNEL	string	Delar av rutten som är tunnlar.
URBAN	string	Delar av rutten som finns i stadsområden.

ResponseTravelMode

Reseläge för den beräknade rutten. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

Name	Typ	Description
bicycle	string	De returnerade vägarna är optimerade för cyklar, inklusive användning av cykelbanor.
bus	string	De returnerade rutterna är optimerade för bussar, inklusive användning av endast bussfiler. BETA-funktioner.
car	string	De returnerade vägarna är optimerade för bilar.
motorcycle	string	De returnerade vägarna är optimerade för motorcyklar. BETA-funktioner.
other	string	Det angivna transportsättet är inte möjligt i det här avsnittet
pedestrian	string	De returnerade vägarna är optimerade för fotgängare, inklusive användning av trottoarer.
taxi	string	De returnerade vägarna är optimerade för taxibilar. BETA-funktioner.
truck	string	De returnerade rutterna är optimerade för nyttofordon, som för lastbilar.
van	string	De returnerade vägarna är optimerade för skåpbilar. BETA-funktioner.

Route

Name	Typ	Description
guidance	RouteGuidance	Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.
legs	RouteLeg[]	Matris med ben
sections	RouteSection[]	Matris för avsnitt
summary	RouteSummary	Sammanfattningsobjekt

RouteDirectionsBatchItem

Ett objekt som returneras från Route Directions Batch-tjänstanropet.

Name	Typ	Description
response	Response	Resultatet av frågan. RouteDirections om frågan har slutförts, ErrorResponse annars.
statusCode	integer	Statuskod för HTTP-begäran.

RouteDirectionsBatchResult

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

Name	Typ	Description
batchItems	RouteDirectionsBatchItem[]	Matris som innehåller batchresultatet.
summary	Summary	Sammanfattning av resultatet för batchbegäran

RouteGuidance

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

Name	Typ	Description
instructionGroups	RouteInstructionGroup[]	Grupper en sekvens med instruktionselement som är relaterade till varandra.
instructions	RouteInstruction[]	En lista över instruktioner som beskriver manövrar.

RouteInstruction

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", "Ankomma".

Name	Typ	Description
combinedMessage	string	Ett mänskligt läsbart meddelande för manövern i kombination med meddelandet från nästa instruktion. Ibland är det möjligt att kombinera två på varandra följande instruktioner i en enda instruktion som gör det lättare att följa. I så fall är flaggan possibleCombineWithNext sann. Exempel: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` Flaggan possibleCombineWithNext på instruktion 10 är sann. Detta anger för klienterna med kodad vägledning att den kan kombineras med instruktion 11. Anvisningarna kombineras automatiskt för klienter som begär läsbar vägledning för människor. Fältet CombinedMessage innehåller det kombinerade meddelandet: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3-tecken ISO 3166-1 alfa-3 landskod. T.ex. USA.
drivingSide	DrivingSide	Anger vänster jämfört med höger sida som kör vid manöverpunkten.
exitNumber	string	Antalet(ar) för en motorvägsavfart som tagits av den aktuella manövern. Om en utgång har flera slutnummer avgränsas de med "" och eventuellt aggregeras med "-", t.ex. "10, 13–15".
instructionType	GuidanceInstructionType	Typ av instruktion, t.ex. sväng eller ändring av vägformulär.
junctionType	JunctionType	Typen av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.
maneuver	GuidanceManeuver	En kod som identifierar manövern.
message	string	Ett mänskligt läsbart meddelande för manövern.
point	LatLongPair	En plats som representeras som latitud och longitud.
pointIndex	integer	Indexet för punkten i listan över polyline"-punkter" som motsvarar instruktionens punkt.
possibleCombineWithNext	boolean	Du kan också kombinera instruktionen med nästa. Detta kan användas för att skapa meddelanden som "Sväng vänster och sedan höger".
roadNumbers	string[]	Vägnummer för nästa betydande vägsegment efter manövern eller av de vägar som ska följas. Exempel: ["E34", "N205"]
roundaboutExitNumber	string	Detta anger vilken utgång som ska ske i en rondell.
routeOffsetInMeters	integer	Avstånd från början av rutten till instruktionens punkt.
signpostText	string	Texten på en skylt som är mest relevant för manövern, eller till den riktning som ska följas.
stateCode	string	En underavdelning (t.ex. delstat) i landet, som representeras av den andra delen av en ISO 3166-2-kod . Detta är endast tillgängligt för vissa länder/regioner som USA, Kanada och Mexiko.
street	string	Gatunamn för nästa betydande vägsegment efter manövern, eller på gatan som bör följas.
travelTimeInSeconds	integer	Uppskattad restid fram till den punkt som motsvarar routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Anger instruktionens riktning. Om junctionType anger en turinstruktion: 180 = U-sväng [-179, -1] = Vänstersväng 0 = Rakt på (en "0 graders" sväng) [1, 179] = Högersväng Om junctionType anger en bifurcation-instruktion: <0 - behåll vänster >0 – håll dig till höger

RouteInstructionGroup

Grupper 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 instructionGroup ett sammanfattningsmeddelande som returneras när det är tillgängligt.

Name	Typ	Description
firstInstructionIndex	integer	Index för den första instruktionen i anvisningarna och tillhör den här gruppen.
groupLengthInMeters	integer	Gruppens längd.
groupMessage	string	Sammanfattningsmeddelande när textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggade).
lastInstructionIndex	integer	Index för den sista instruktionen i anvisningarna och tillhör den här gruppen.

RouteLeg

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

Name	Typ	Description
points	LatLongPair[]	Matris med punkter
summary	RouteLegSummary	Sammanfattningsobjekt för vägavsnitt.

RouteLegSummary

Sammanfattningsobjekt för vägavsnitt.

Name	Typ	Description
arrivalTime	string	Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.
batteryConsumptionInkWh	number	Uppskattad elenergiförbrukning i kilowattimmar (kWh) med hjälp av modellen för elektrisk förbrukning. Ingår om vehicleEngineType är inställt på elektrisk och constantSpeedConsumptionInkWhPerHundredkm anges. Värdet för batteryConsumptionInkWh inkluderar den återhämtningsbara elenergin och kan därför vara negativ (vilket indikerar att energin ökar). Om både maxChargeInkWh och currentChargeInkWh anges begränsas återställningen för att säkerställa att batteriladdningsnivån aldrig överskrider maxChargeInkWh. Om varken maxChargeInkWh eller currentChargeInkWh anges antas obegränsad återhämtning i förbrukningsberäkningen.
departureTime	string	Beräknad avgångstid för rutten eller benet. Tiden är i UTC.
fuelConsumptionInLiters	number	Uppskattad bränsleförbrukning i liter med hjälp av förbränningsförbrukningsmodellen. Ingår om vehicleEngineType är inställt på förbränning och constantSpeedConsumptionInLitersPerHundredkm anges. Värdet blir icke-negativt.
historicTrafficTravelTimeInSeconds	integer	Beräknad restid som beräknas med hjälp av tidsberoende historiska trafikdata. Ingår endast om computeTravelTimeFor = alla används i frågan.
lengthInMeters	integer	Egenskapen Längd i meter
liveTrafficIncidentsTravelTimeInSeconds	integer	Beräknad restid som beräknas med hjälp av hastighetsdata i realtid. Ingår endast om computeTravelTimeFor = alla används i frågan.
noTrafficTravelTimeInSeconds	integer	Beräknad restid beräknad som om det inte finns några förseningar på rutten på grund av trafikförhållanden (t.ex. överbelastning). Ingår endast om computeTravelTimeFor = alla används i frågan.
trafficDelayInSeconds	integer	Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med olika typer av trafikinformation måste parametern computeTravelTimeFor=all läggas till.
travelTimeInSeconds	integer	Uppskattad restid i egenskapen sekunder som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med hjälp av tidsberoende historiska trafikdata.

RouteOptimizedWaypoint

Optimerat vägpunktsobjekt.

Name	Typ	Description
optimizedIndex	integer	Optimerat vägpunktsindex från systemet.
providedIndex	integer	Vägpunktsindex som tillhandahålls av användaren.

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

Name	Typ	Description
effectiveSettings	EffectiveSetting[]	Effektiva parametrar eller data som används vid anrop av det här routnings-API:et.

RouteSection

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

Name	Typ	Description
delayInSeconds	integer	Fördröjning i sekunder som orsakas av incidenten.
effectiveSpeedInKmh	integer	Incidentens effektiva hastighet i km/h, i genomsnitt över hela dess längd.
endPointIndex	integer	Index för den sista punkten (förskjutning 0) i den väg som det här avsnittet gäller för.
magnitudeOfDelay	DelayMagnitude	Omfattningen av förseningen som orsakas av incidenten. Dessa värden motsvarar värdena för svarsfältet ty i API:et Get Traffic Incident Detail.
sectionType	ResponseSectionType	Avsnittstyper för det rapporterade vägsvaret
simpleCategory	SimpleCategory	Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Se "tec" för detaljerad information.
startPointIndex	integer	Index för den första punkten (förskjutning 0) i den väg som det här avsnittet gäller för.
tec	RouteSectionTec	Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.
travelMode	ResponseTravelMode	Resläge för den beräknade vägen. Värdet anges till `other` om det begärda transportsättet inte är möjligt i det här avsnittet

RouteSectionTec

Information om trafikhändelsen med definitioner i TPEG2-TEC-standarden . Kan innehålla effectCode och orsakar element.

Name	Typ	Description
causes	RouteSectionTecCause[]	Orsaksmatris
effectCode	integer	Effekten på trafikflödet. Innehåller ett värde i tabellen tec001:EffectCode enligt definitionen i TPEG2-TEC-standarden . Kan användas för att färgkoda trafikhändelser efter allvarlighetsgrad.

RouteSectionTecCause

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

Name	Typ	Description
mainCauseCode	integer	Den främsta orsaken till trafikhändelsen. Innehåller ett värde i tabellen tec002:CauseCode enligt definitionen i TPEG2-TEC-standarden .
subCauseCode	integer	Undercause av trafikhändelsen. Innehåller ett värde i underorsakstabellen som definieras av mainCauseCode, enligt definitionen i TPEG2-TEC-standarden .

RouteSummary

Sammanfattningsobjekt

Name	Typ	Description
arrivalTime	string	Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.
departureTime	string	Beräknad avgångstid för rutten eller benet. Tiden är i UTC.
lengthInMeters	integer	Egenskapen Längd i meter
trafficDelayInSeconds	integer	Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med olika typer av trafikinformation måste parametern computeTravelTimeFor=all läggas till.
travelTimeInSeconds	integer	Uppskattad restid i egenskapen sekunder som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med hjälp av tidsberoende historiska trafikdata.

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".

Name	Typ	Description
JAM	string	Trafikstockning.
OTHER	string	Annat.
ROAD_CLOSURE	string	Vägavstängning.
ROAD_WORK	string	Vägarbete.

Summary

Sammanfattning av resultatet för batchbegäran

Name	Typ	Description
successfulRequests	integer	Antal lyckade begäranden i batchen
totalRequests	integer	Totalt antal begäranden i batchen

Share via

Route - Post Route Directions Batch

Skicka asynkron Batch-begäran

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

Ladda ned asynkrona Batch-resultat

Batch-svarsmodell

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

AADToken

Kommentarer

Scopes

subscription-key

SAS Token

Exempel

Successfully submit a route direction batch request

Sample Request

Sample Response

Definitioner

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Ytterligare resurser