Route - Post Route Directions Batch

Referens

Tjänst:: Maps

API-version:: 2025-01-01

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

Route Directions Batch-API:et är en HTTP-POST begäran som skickar batchar på upp till 100 frågor i ett enda anrop till API:et Route Directions.

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

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

Om du vill skicka riktningar 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 2 riktningar frågor:

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

En riktningar batchItem-objekt kan acceptera någon av de riktningar som stödsbegärandetexten

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. 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 är av någon av följande typer:

DirectionsResponse – Om frågan har slutförts.
Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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äkerhetsmodellen. 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 för vägledning.
Accept-Language		string	Språk där routningsresultat ska returneras. Mer information finns i lokaliseringsstöd i Azure Maps.

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äkerhetsmodellen. 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 för vägledning.

Accept-Language

string

Språk där routningsresultat ska returneras.

Mer information finns i lokaliseringsstöd i Azure Maps.

Begärandetext

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

Svar

Name	Typ	Description
200 OK	DirectionsBatchResponse	Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.
Other Status Codes	MapsErrorResponse	Ett oväntat fel uppstod. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

DirectionsBatchResponse

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

Other Status Codes

MapsErrorResponse

Ett oväntat fel uppstod.

Sidhuvuden

x-ms-error-code: string

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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-resurskonton 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 till 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 få åtkomstkontroll för specifika API:er och omfång.

Anmärkning

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, 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 Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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 skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de utfärdas för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 mer säkert 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.

Typ: apiKey
I: header

Exempel

A Route Directions Batch request containing 2 queries

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
Address	Resultatets adress. `Note`: Stöds endast för truck travelMode.
AdminDistrict	Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region.
AdminDistricts	Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region.
AdrTunnelRestrictionCodeEnum	Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods.
AvoidEnum	Anger begränsningar som vägberäkningen ska uppfylla när du bestämmer vägen. Undvik stöder flera värden i en begäran och stöds endast för körning och lastbilsresorMode. Exempel: "avoid": ["limitedAccessHighways", "tollRoads"]
CountryRegion	Representerar ett land eller en region som innehåller relaterad information.
DirectionsBatchRequestBody	Listan över vägbeskrivningar för frågor/begäranden att bearbeta. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga.
DirectionsBatchRequestItem	Batch Query-objekt
DirectionsBatchResponse	Det här objektet returneras från ett lyckat Directions Batch-tjänstanrop.
DirectionsBatchResponseItem	Batch-svarsobjekt
DrivingSideEnum	Anger vänster eller höger sida körning vid tidpunkten för manövern. `Note`: Stöds endast för truck travelMode.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
FeatureCollection	`GeoJSON` `FeatureCollection` objekt som innehåller en lista över funktioner. Mer information finns i RFC 7946, avsnitt 3.3.
FeaturesItem	GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för vägen.
FeaturesItemTypeEnum	Anger `GeoJSON` typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.
FeatureTypeEnum	Anger `GeoJSON` typ. Den enda objekttypen som stöds är `FeatureCollection`. Mer information finns i RFC 7946.
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946.
Hint	Ytterligare information som kan vara till hjälp när du följer en väg. Förutom tipstexten har det här elementet ett attribut hintType som anger vad tipset refererar till, till exempel "NextIntersection". Tips är ett valfritt element. `Note`: Stöds endast för att köra travelMode.
InputWaypointFeaturesItem	Anger indata waypoint och viaWaypoint `GeoJSON` funktionsobjekt och ytterligare egenskaper. Mer information finns i RFC 7946.
InputWaypointProperties	Anger egenskaperna för en vägpunkt som är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.
InputWaypointTypeEnum	Waypoint-typ på vägen. Det kan vara ett stopp eller en mellanliggande plats som vägen måste passera.
Instruction	En beskrivning av en manöver i en uppsättning riktningar.
Leg	Information om ett avsnitt av en väg mellan två vägpunkter. Mer information om fälten som finns i en väg leg:
ManeuverPointProperties	Anger körinstruktioner och ytterligare egenskaper för varje manöverpunkt i vägbenet.
ManeuverTypeEnum	Den typ av manöver som beskrivs i den här detaljerade samlingen. ManeuverType innehåller information om en del av manövern som anges i motsvarande instruktion. Till exempel kan maneuverType för en instruktion ange TurnLeftThenTurnRight, medan de associerade detaljobjekten kan ge detaljer om TurnLeft- och TurnRight-manövrarna
MapsErrorDetail	Felinformationen.
MapsErrorResponse	Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.
MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
MultiLineStringGeometry	Anger objektet `GeoJSON` Geometri för MultiLineString. Mer information finns i RFC 7946.
OptimizedWaypoint	Optimerat vägpunktsobjekt.
Order	Sekvens för att besöka waypoints och viaWaypoints.
PointGeometry	Ursprungspunkten skickades som ett giltigt `GeoJSON` geometriobjekt, från vilket intervallets polygon ska beräknas. Mer information finns i RFC 7946. `Note`: API:et fäster den begärda ursprungspunkten till närmaste vägnätverk och använder den för intervallberäkning. Den returneras som en `center` punkt i svaret.
RegionTravelSummary	Resesammanfattning av avstånd, tid och avgiftsbelagt vägavstånd efter två entitetstyper: land (t.ex. USA, Kanada) och administrativ division eller underregion (t.ex. "delstat" i USA och "provins" i Kanada).
RoadTypeEnum	Typ av väg. `Note`: Stöds endast för att köra travelMode.
RouteDirectionOptimizeRouteEnum	Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation. Exempel: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec	Anger fordonsattribut som storlek, vikt, maxhastighet, lasttyp osv. endast för lastbilsroutning. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna. IS`Note`: Stöds endast för truck travelMode.
RouteOutputOptionEnum	Inkludera önskad väginformation från svaret. Som standard ingår resplanen i svaret. Stöder flera värden, till exempel "routeOutputOptions": ["routePath", "regionTravelSummary"]
RoutePathPoint	Refererar till indexet för en punkt inom en specifik del av en väg.
RoutePathProperties	Anger de egenskaper som beskriver vägens sökväg i svaret.
RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.
RoutePathTravelModeEnum	Färdsättet för vägsökvägen i svaret.
SideOfStreetEnum	Sidan av gatan där målet finns baserat på ankomstriktningen. Det här fältet gäller endast för den sista manöverpunkten.
Step	Ett vägben innehåller instruktioner för sväng-för-sväng. Ett steg refererar till ett intervall av en väg mellan två på varandra följande manövreringspunkter.
SubLeg	Information om ett segment av routningsbenet som definieras av vägbensvägpunkterna och eventuella mellanliggande viavägspunkter. Om vägen Leg till exempel har två viavägspunkter utöver start- och slutvägspunkter skulle det finnas tre (3) routningsunderben.
Summary	Sammanfattning av batchbegäran
TrafficCongestionEnum	Trafikstockningsnivån längs vägen. `Note`: Stöds endast för att köra resorMode
TrafficDataUsedEnum	Typen av trafikdata i realtid som används för att generera vägen.
TravelModeEnum	Färdsätt för den begärda vägen. Om det inte definieras är standardvärdet "körning" som returnerar den väg som är optimerad för bilar. `Note`: För lastbilsresorMode kanske den begärda lastbilsvägen inte är tillgänglig för hela vägen. Om lastbilsvägen inte är tillgänglig för ett visst avsnitt är travelMode-elementet i svaret för det avsnittet "annat". Exempel: "travelMode":"driving"
VehicleLoadTypeEnum	Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder. vehicleLoadType stöder flera värden i en begäran.
ViaWaypointProperties	Anger egenskaperna för en `ViaWaypoint` som är en vägpunkt som måste skickas genom eller besökas längs en väg eller resa.
WaypointProperties	Anger egenskaperna för en vägpunkt som är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.

Address

Objekt

Resultatets adress. Note: Stöds endast för truck travelMode.

Name	Typ	Description
adminDistricts	AdminDistricts[]	Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region.
countryRegion	CountryRegion	Representerar ett land eller en region som innehåller relaterad information.

AdminDistrict

Objekt

Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region.

Name	Typ	Description
distanceInMeters	number	Det totala avståndet som färdas i meter inom det administrativa distriktet.
durationInSeconds	integer (int64)	Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden.
durationTrafficInSeconds	integer (int64)	Den tid det tar i sekunder att resa en motsvarande `TravelDistance` med aktuella trafikförhållanden. Det här värdet anges om `optimizeRoute` innehåller trafiköverväganden.
longName	string	Det långa namnet på en adress, till exempel Washington.
tollDistanceInMeters	number	Det totala avståndet, mätt i meter, längs den väg som inkluderar avgiftsbelagda vägar.

AdminDistricts

Objekt

Name	Typ	Description
shortName	string	Det korta namnet på motsvarande adminDistrict-fält, För adminDistrict[0], kan det här vara ett kort namn på tillståndet, till exempel WA. Detta är endast tillgängligt för USA, Kanada och Mexiko.

AdrTunnelRestrictionCodeEnum

Uppräkning

Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods.

Värde	Description
B	Fordon med kod B är begränsade från vägar med ADR-tunnelkategorierna B, C, D och E.
C	Fordon med kod C är begränsade från vägar med ADR-tunnelkategorierna C, D och E
D	Fordon med kod D är begränsade från vägar med ADR-tunnelkategorierna D och E.
E	Fordon med kod E är begränsade från vägar med ADR-tunnel kategori E.

AvoidEnum

Uppräkning

Anger begränsningar som vägberäkningen ska uppfylla när du bestämmer vägen. Undvik stöder flera värden i en begäran och stöds endast för körning och lastbilsresorMode.

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

Värde	Description
borderCrossings	Undviker att korsa landsgränser i vägen.
ferries	Undviker användning av färjor i rutten.
limitedAccessHighways	Undviker användning av motorvägar med begränsad åtkomst i vägen.
lowEmissionZones	Undviker utsläppssnåla zoner i rutten. `Note`: Stöds endast för truck travelMode.
tollRoads	Undviker användning av avgiftsbelagda vägar i vägen.
tunnels	Undviker användning av tunnlar i vägen. `Note`: Stöds endast för truck travelMode.
unpavedRoads	Undviker osparade vägar i vägen. `Note`: Stöds endast för truck travelMode.

CountryRegion

Objekt

Representerar ett land eller en region som innehåller relaterad information.

Name	Typ	Description
name	string	namn på land/region

DirectionsBatchRequestBody

Objekt

Listan över vägbeskrivningar för frågor/begäranden att bearbeta. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga.

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

DirectionsBatchRequestItem

Objekt

Batch Query-objekt

Name	Typ	Standardvärde	Description
arriveAt	string (date-time)		Datum och tid för ankomst till målpunkten formaterat som ett `dateTime` värde som definieras av RFC 3339, avsnitt 5.6. När en tidszonsförskjutning inte har angetts antas UTC. Parametern `arriveAt` kan inte användas tillsammans med `departAt`. Exempel: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid	AvoidEnum[]		Anger begränsningar som vägberäkningen ska uppfylla när du bestämmer vägen. Undvik stöder flera värden i en begäran och stöds endast för körning och lastbilsresorMode. Exempel: "avoid": ["limitedAccessHighways", "tollRoads"]
departAt	string (date-time)		Datum och tid för avresa från ursprungspunkten formaterat som ett `dateTime` värde som definieras av RFC 3339, avsnitt 5.6. När en tidszonsförskjutning inte har angetts antas UTC. Om `departAt` inte har angetts är standardvärdet den aktuella tiden. Exempel: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		Kör- och gångvägar definieras av en uppsättning vägpunkter (stopp) och viaWaypoints (mellanliggande platser som vägen måste passera). Du kan ha högst 25 vägpunkter och högst 10 viaWaypoints mellan varje uppsättning waypoints. Lastbilsvägen stöder upp till 150 vägpunkter och viaWaypoints stöds inte. En väg måste ha minst 2 vägpunkter och start- och slutpunkterna för vägen kan inte vara viaWaypoints. Både waypoint- och viaWaypoint-platser måste anges som ett giltigt GeoJSON Point-funktionsobjekt tillsammans med pointIndex som anger platsordningen. Mer information om GeoJSON-formatet finns i RFC 7946.
heading	integer (int64) minimum: 0 maximum: 359		Fordonets initiala riktningsriktning i grader som börjar på true North och fortsätter i medsols riktning. Norr är 0 grader, öst är 90 grader, söder är 180 grader, väst är 270 grader. Möjliga värden 0–359
maxRouteCount	integer (int64) minimum: 1 maximum: 3		Det maximala antalet vägar som ska returneras. Tillgänglig för kör- och lastbilstransportlägen. För körvägar stöder den här parametern vägar med upp till två vägpunkter utöver ursprunget och målet och parametern avoid får inte anges. Standard: "maxRouteCount":1 Minimum: "maxRouteCount":1 Max: "maxRouteCount":3
optimizeRoute	RouteDirectionOptimizeRouteEnum	fastestWithoutTraffic	Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation. Exempel: "optimizeRoute":"shortest"
optimizeWaypointOrder	boolean	False	Sortera om vägvägspunkterna med hjälp av en snabb heuristisk algoritm för att minska den vägkostnad som anges med parametern optimize. Ursprunget och målet undantas från den optimerade waypointen och deras position anses vara fast. Acceptabla värden är sanna eller falska. `Note`: Stöds endast för truck travelMode.
optionalId	string		ID för begäran som visas i motsvarande batchItem.
routeOutputOptions	RouteOutputOptionEnum[]	[ "itinerary" ]	Inkludera önskad väginformation från svaret. Som standard ingår resplanen i svaret. Stöder flera värden, till exempel "routeOutputOptions": ["routePath", "regionTravelSummary"]
travelMode	TravelModeEnum	driving	Färdsätt för den begärda vägen. Om det inte definieras är standardvärdet "körning" som returnerar den väg som är optimerad för bilar. `Note`: För lastbilsresorMode kanske den begärda lastbilsvägen inte är tillgänglig för hela vägen. Om lastbilsvägen inte är tillgänglig för ett visst avsnitt är travelMode-elementet i svaret för det avsnittet "annat". Exempel: "travelMode":"driving"
type	FeatureTypeEnum		Anger `GeoJSON` typ. Den enda objekttypen som stöds är `FeatureCollection`. Mer information finns i RFC 7946.
vehicleSpec	RouteDirectionVehicleSpec		Anger fordonsattribut som storlek, vikt, maxhastighet, lasttyp osv. endast för lastbilsroutning. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna. `Note`: Stöds endast för lastbilsresorMode

DirectionsBatchResponse

Objekt

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

Name	Typ	Description
batchItems	DirectionsBatchResponseItem[]	Matris som innehåller batchresultatet.
summary	Summary	Sammanfattning av batchbegäran

DirectionsBatchResponseItem

Objekt

Batch-svarsobjekt

Name	Typ	Description
alternativeRoutes	FeatureCollection[]	Alternativ väg.
error	ErrorDetail	Felinformationen.
features	FeaturesItem[]	`GeoJSON` funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper. Mer information finns i RFC 7946, avsnitt 3.2.
optionalId	string	ID för begäran som visas i motsvarande batchItem.
type	FeatureTypeEnum	Anger `GeoJSON` typ. Den enda objekttypen som stöds är `FeatureCollection`. Mer information finns i RFC 7946.

DrivingSideEnum

Uppräkning

Anger vänster eller höger sida körning vid tidpunkten för manövern. Note: Stöds endast för truck travelMode.

Värde	Description
Left	Vänster sidokörning.
Right	Höger sidokörning.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

FeatureCollection

Objekt

GeoJSON FeatureCollection objekt som innehåller en lista över funktioner. Mer information finns i RFC 7946, avsnitt 3.3.

Name	Typ	Description
features	FeaturesItem[]	`GeoJSON` funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper. Mer information finns i RFC 7946, avsnitt 3.2.
type	FeatureTypeEnum	Anger `GeoJSON` typ. Den enda objekttypen som stöds är `FeatureCollection`. Mer information finns i RFC 7946.

FeaturesItem

Objekt

GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för vägen.

Name	Typ	Description
bbox	number[] (double)	Ett rektangulärt område på jorden som definieras som ett avgränsningsramobjekt. Rektanglarnas sidor definieras av latitud- och longitudvärden. Mer information finns i RFC 7946, avsnitt 5. Exempel: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	RouteDirectionsGeometry: MultiLineStringGeometry PointGeometry	Ett giltigt `GeoJSON` geometriobjekt. Mer information finns i RFC 7946.
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	Anger funktionsegenskaperna för rutten, till exempel resväg, routningsben och geometri, resesammanfattning.
type	FeaturesItemTypeEnum	Anger `GeoJSON` typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.

FeaturesItemTypeEnum

Uppräkning

Anger GeoJSON typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.

Värde	Description
Feature	Anger objekttypen `GeoJSON` funktion.

FeatureTypeEnum

Uppräkning

Anger GeoJSON typ. Den enda objekttypen som stöds är FeatureCollection. Mer information finns i RFC 7946.

Värde	Description
FeatureCollection	Anger `GeoJSONFeatureCollection` objekttyp.

GeoJsonPoint

Objekt

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

Name	Typ	Description
coordinates	number[] (double)	En `Position` är en matris med tal med två eller flera element. De första två elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946.
type	string: Point	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Hint

Objekt

Ytterligare information som kan vara till hjälp när du följer en väg. Förutom tipstexten har det här elementet ett attribut hintType som anger vad tipset refererar till, till exempel "NextIntersection". Tips är ett valfritt element. Note: Stöds endast för att köra travelMode.

Name	Typ	Description
hintType	string	tipstyp.
text	string	tipstext.

InputWaypointFeaturesItem

Objekt

Anger indata waypoint och viaWaypoint GeoJSON funktionsobjekt och ytterligare egenskaper. Mer information finns i RFC 7946.

Name	Typ	Description
geometry	GeoJsonPoint: PointGeometry	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946.
properties	InputWaypointProperties	Anger egenskaperna för en vägpunkt som är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.
type	FeaturesItemTypeEnum	Anger `GeoJSON` typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.

InputWaypointProperties

Objekt

Anger egenskaperna för en vägpunkt som är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.

Name	Typ	Standardvärde	Description
pointIndex	integer (int64)		Identifiera och sortera sekvensen av waypoints i vägen. Standardvärdet är `index value` för en funktionsmatris.
pointType	InputWaypointTypeEnum	waypoint	Waypoint-typ på vägen. Det kan vara ett stopp eller en mellanliggande plats som vägen måste passera.

InputWaypointTypeEnum

Uppräkning

Waypoint-typ på vägen. Det kan vara ett stopp eller en mellanliggande plats som vägen måste passera.

Värde	Description
viaWaypoint	En viaWaypoint är en specifik vägpunkt som måste skickas genom eller besökas längs en väg eller resa. `Note`: Stöds endast för att köra travelMode.
waypoint	En vägpunkt är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.

Instruction

Objekt

En beskrivning av en manöver i en uppsättning riktningar.

Name	Typ	Description
drivingSide	DrivingSideEnum	Anger vänster eller höger sida körning vid tidpunkten för manövern. `Note`: Stöds endast för truck travelMode.
formattedText	string	Instruktionens formaterade textbeskrivning.
hints	Hint[]	Ytterligare information som kan vara till hjälp när du följer en väg. Förutom tipstexten har det här elementet ett attribut hintType som anger vad tipset refererar till, till exempel "NextIntersection". Tips är ett valfritt element och ett vägsteg kan innehålla mer än ett tips. `Note`: Stöds endast för att köra resorMode
maneuverType	ManeuverTypeEnum	Den typ av manöver som beskrivs i den här detaljerade samlingen. ManeuverType innehåller information om en del av manövern som anges i motsvarande instruktion. Till exempel kan maneuverType för en instruktion ange TurnLeftThenTurnRight, medan de associerade detaljobjekten kan ge detaljer om TurnLeft- och TurnRight-manövrarna
text	string	Beskrivning av oformaterad text för instruktionen.

Leg

Objekt

Information om ett avsnitt av en väg mellan två vägpunkter. Mer information om fälten som finns i en väg leg:

Name	Typ	Description
arrivalAt	string (date-time)	Den uppskattade ankomsttiden för benet, som tar hänsyn till trafikvillkoren, formateras som ett dateTime-värde som definieras av RFC 3339, avsnitt 5.6. Den refererar till tidszonsförskjutningen med antingen `departAt` eller `arrivalAt`. Annars används UTC-tiden.
departureAt	string (date-time)	Den uppskattade avgångstiden för benet, som tar hänsyn till trafikförhållandena, formateras som ett dateTime-värde som definieras av RFC 3339, avsnitt 5.6. Den refererar till tidszonsförskjutningen med antingen `departAt` eller `arrivalAt`. Annars används UTC-tiden.
description	string	En kort beskrivning av vägen.
distanceInMeters	number	Det fysiska avståndet i mätare som täcks av en väg Leg.
durationInSeconds	integer (int64)	Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden.
durationTrafficInSeconds	integer (int64)	Den tid det tar i sekunder att resa en motsvarande `TravelDistance` med aktuella trafikförhållanden. Det här värdet anges om `optimizeRoute` innehåller trafiköverväganden.
regionTravelSummary	RegionTravelSummary	Inkludera resesammanfattning av avstånd, tid och vägtullar efter två entitetstyper: land (t.ex. USA, Kanada) och administrativ division eller underregion (t.ex. "delstat" i USA och "provins" i Kanada).
routePathRange	RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.
subLegs	SubLeg[]	Information om ett segment av routningsbenet som definieras av vägbensvägpunkterna och eventuella mellanliggande viavägspunkter. Om vägen Leg till exempel har två viavägspunkter utöver start- och slutvägspunkter skulle det finnas tre (3) routningsunderben.

ManeuverPointProperties

Objekt

Anger körinstruktioner och ytterligare egenskaper för varje manöverpunkt i vägbenet.

Name	Typ	Standardvärde	Description
address	Address		Resultatets adress. `Note`: Stöds endast för truck travelMode.
compassDirection	string		Färdriktningen i samband med en manöver på en väg, till exempel söder eller sydväst. `Note`: Stöds endast för att köra travelMode.
distanceInMeters	number		Det fysiska avståndet i mätare som omfattas av det här vägsteget.
durationInSeconds	integer (int64)		Den tid det tar i sekunder att resa en motsvarande `TravelDistance`.
exitIdentifier	string		Namnet eller numret på avslutet som är associerat med det här vägsteget.
instruction	Instruction		En beskrivning av en manöver i en uppsättning riktningar.
order	Order		Sekvens för att besöka waypoints och viaWaypoints.
routePathPoint	RoutePathPoint		Refererar till indexet för en punkt inom en specifik del av en väg.
sideOfStreet	SideOfStreetEnum		Sidan av gatan där målet finns baserat på ankomstriktningen. Det här fältet gäller endast för den sista manöverpunkten.
signs	string[]		Skyltningstext för vägen. Det kan finnas fler än ett teckenvärde.
steps	Step[]		Steg mellan två på varandra följande manöverpunkter.
towardsRoadName	string		Namnet på gatan som vägen går mot i den första `ManeuverPoint`.
travelMode	RoutePathTravelModeEnum	driving	Färdsättet för vägsökvägen i svaret.
type	string: ManeuverPoint		Utdatatyp.

ManeuverTypeEnum

Uppräkning

Den typ av manöver som beskrivs i den här detaljerade samlingen. ManeuverType innehåller information om en del av manövern som anges i motsvarande instruktion. Till exempel kan maneuverType för en instruktion ange TurnLeftThenTurnRight, medan de associerade detaljobjekten kan ge detaljer om TurnLeft- och TurnRight-manövrarna

Värde	Description
ArriveFinish	Anländer till slutdestinationen.
ArriveIntermediate	Kom fram till en mellanliggande vägpunkt.
BearLeft	Björn till vänster.
BearLeftThenBearLeft	Björn vänster och sedan björn vänster igen.
BearLeftThenBearRight	Bär vänster och bär sedan höger.
BearLeftThenTurnLeft	Bär vänster och sväng sedan vänster.
BearLeftThenTurnRight	Bär vänster och sväng sedan åt höger.
BearRight	Ha rätt.
BearRightThenBearLeft	Bär höger och bär sedan vänster.
BearRightThenBearRight	Bär rätt och bär sedan rätt igen.
BearRightThenTurnLeft	Bär åt höger och sväng sedan åt vänster.
BearRightThenTurnRight	Bär åt höger och sväng sedan åt höger.
BearThenKeep	Björninstruktion och sedan en behåll-instruktion
BearThenMerge	Bär instruktion och sedan en sammanslagningsinstruktion.
Continue	Fortsätt på den aktuella vägen.
DepartIntermediateStop	Lämna en mellanliggande vägpunkt i en annan riktning och väg än du kom på.
DepartIntermediateStopReturning	Lämna en mellanliggande vägpunkt i samma riktning och på samma väg som du kom på.
DepartStart	Lämna startpunkten.
EnterRoundabout	Ange en rondell.
EnterThenExitRoundabout	Ange och avsluta en rondell.
ExitRoundabout	Avsluta en rondell.
ExitRoundaboutLeft	Vid rondellen tar du avfarten till vänster.
ExitRoundaboutRight	Vid rondellen tar du avfarten till höger.
Follow	Följa.
GoAroundRoundabout	Gå runt i rondellen.
KeepLeft	Håll vänster på en annan väg.
KeepOnRampLeft	Håll vänster och fortsätt på rampen.
KeepOnRampRight	Håll dig till höger och fortsätt på rampen.
KeepOnRampStraight	Håll dig rak och fortsätt på rampen.
KeepRight	Håll dig på en annan väg.
KeepStraight	Håll dig rakt på en annan väg.
KeepToStayLeft	Håll vänster för att stanna på samma väg.
KeepToStayRight	Håll dig på samma väg.
KeepToStayStraight	Håll dig rak för att stanna på samma väg.
MergeFreeway	Slå ihop på en motorväg.
MergeHighway	Slå ihop på en motorväg.
MergeMotorway	Gå samman på en motorväg.
MotorwayExitLeft	Ta vänster utgång.
MotorwayExitRight	Ta höger utgång.
None	Ingen instruktion.
RampThenHighwayLeft	Ta vänster ramp på motorvägen. Detta är en del av en kombinerad instruktion.
RampThenHighwayRight	Ta höger ramp på motorvägen. Detta är en del av en kombinerad instruktion.
RampThenHighwayStraight	Håll dig rak för att ta rampen på motorvägen. Detta är en del av en kombinerad instruktion.
RoadNameChange	Vägnamn ändras.
SwitchToMainRoad	Byt till huvudvägen.
SwitchToParallelRoad	Växla till den parallella vägen.
Take	Ta vägen. Den här instruktionen används när du går in i eller lämnar en färja.
TakeExit	Ta avslutet.
TakeFerry	Ta färjan.
TakeRamp	Ta rampen.
TakeRampLeft	Ta rampen till vänster.
TakeRampRight	Ta rampen till höger.
TakeRampStraight	Håll dig rak för att ta rampen.
TurnBack	Vänd tillbaka skarpt.
TurnLeft	Sväng vänster.
TurnLeftSharp	Ta en skarp vänstersväng.
TurnLeftThenBearLeft	Sväng vänster och bär sedan vänster.
TurnLeftThenBearRight	Sväng vänster och bär sedan höger.
TurnLeftThenTurnLeft	Sväng vänster och sväng sedan vänster igen.
TurnLeftThenTurnRight	Sväng vänster och sväng sedan åt höger.
TurnRight	Sväng höger.
TurnRightSharp	Ta en skarp högersväng.
TurnRightThenBearLeft	Sväng höger och bär sedan vänster.
TurnRightThenBearRight	Sväng höger och bär sedan höger.
TurnRightThenTurnLeft	Sväng höger och sväng sedan vänster.
TurnRightThenTurnRight	Sväng höger och sväng sedan åt höger igen
TurnThenMerge	Vänd instruktionen följt av en sammanslagningsinstruktion.
TurnToStayLeft	Sväng vänster för att stanna på samma väg.
TurnToStayRight	Sväng höger för att stanna på samma väg.
UTurn	Gör en u-sväng för att gå i motsatt riktning.
Unknown	Instruktionen är okänd.
Wait	Vänta
Walk	Gå

MapsErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	MapsErrorDetail[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

MapsErrorResponse

Objekt

Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.

Name	Typ	Description
error	MapsErrorDetail	Felinformationen.

MapsInnerError

Objekt

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name	Typ	Description
code	string	Felkoden.
innererror	MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

MultiLineStringGeometry

Objekt

Anger objektet GeoJSON Geometri för MultiLineString. Mer information finns i RFC 7946.

Name	Typ	Description
coordinates	number[] (double)	Koordinater för `GeoJson MultiLineString` geometri.
type	string: MultiLineString	Anger geometritypen för objektet `GeoJSON` Geometri. Mer information finns i RFC 7946.

OptimizedWaypoint

Objekt

Optimerat vägpunktsobjekt.

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

Order

Objekt

Sekvens för att besöka waypoints och viaWaypoints.

Name	Typ	Description
inputIndex	integer (int64)	Användarangivet index för waypoint- och viaWaypoint-indata.
optimizedIndex	integer (int64)	Systemoptimerad waypoint och viaWaypoint-index.

PointGeometry

Objekt

Ursprungspunkten skickades som ett giltigt GeoJSON geometriobjekt, från vilket intervallets polygon ska beräknas. Mer information finns i RFC 7946.

Note: API:et fäster den begärda ursprungspunkten till närmaste vägnätverk och använder den för intervallberäkning. Den returneras som en center punkt i svaret.

Name	Typ	Description
coordinates	number[] (double)	En `Position` är en matris med tal med två eller flera element. De första två elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946.
type	string: Point	Anger geometritypen för objektet `GeoJSON` Geometri. Mer information finns i RFC 7946.

RegionTravelSummary

Objekt

Resesammanfattning av avstånd, tid och avgiftsbelagt vägavstånd efter två entitetstyper: land (t.ex. USA, Kanada) och administrativ division eller underregion (t.ex. "delstat" i USA och "provins" i Kanada).

Name	Typ	Description
adminDistricts	AdminDistrict[]	adminDistrict-matris.
countryRegion	CountryRegion	Representerar ett land eller en region som innehåller relaterad information.
distanceInMeters	number	Egenskapen Längd i meter
durationInSeconds	integer (int64)	Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden.
durationTrafficInSeconds	integer (int64)	Den tid det tar i sekunder att resa en motsvarande `TravelDistance` med aktuella trafikförhållanden. Det här värdet anges om `optimizeRoute` innehåller trafiköverväganden.
tollDistanceInMeters	number	Det totala avståndet, mätt i meter, längs den väg som inkluderar avgiftsbelagda vägar.

RoadTypeEnum

Uppräkning

Typ av väg. Note: Stöds endast för att köra travelMode.

Värde	Description
Arterial	Arteriell.
Ferry	Färja.
Highway	Motorväg.
LimitedAccessHighway	LimitedAccessHighway.
MajorRoad	MajorRoad.
NotApplicable	NotApplicable.
Ramp	Ramp.
Street	Gata.
WalkingPath	WalkingPath.

RouteDirectionOptimizeRouteEnum

Uppräkning

Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation.

Exempel: "optimizeRoute":"shortest"

Värde	Description
fastestAvoidClosureWithoutTraffic	Rutten beräknas för att minimera tiden och undvika vägavstängningar. Ingen trafikinformation förutom vägavstängningar används i beräkningen. `Note`: Stöds endast för att köra travelMode.
fastestWithTraffic	Vägen beräknas för att minimera tiden med aktuell trafikinformation. `Note`: Stöds endast för körning och lastbilsresorMode.
fastestWithoutTraffic	Hittar den snabbaste vägen, utan att ta hänsyn till trafikinformation.
shortest	Vägen beräknas för att minimera avståndet. Trafikinformation används inte.

RouteDirectionVehicleSpec

Objekt

Anger fordonsattribut som storlek, vikt, maxhastighet, lasttyp osv. endast för lastbilsroutning. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna.

ISNote: Stöds endast för truck travelMode.

Name	Typ	Standardvärde	Description
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods.
axleCount	integer (int64)		Antalet axlar på fordonet.
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	Fordonets vikt per axel i kg. Värdet 0 innebär att viktbegränsningar per axel inte beaktas.
height	number (double) minimum: 0 maximum: 1000000	0	Fordonets höjd i meter. Värdet 0 innebär att höjdbegränsningar inte beaktas.
isVehicleCommercial	boolean	False	Om fordonet används i kommersiellt syfte. Nyttofordon får inte köra på vissa vägar.
length	number (double) minimum: 0 maximum: 1000000	0	Fordonets längd i meter. Värdet 0 innebär att längdbegränsningar inte beaktas.
loadType	VehicleLoadTypeEnum[]		Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder. vehicleLoadType stöder flera värden i en begäran.
maxSpeed	integer (int64) minimum: 0 maximum: 250	0	Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon tillåts på motorvägar. Värdet 0 innebär att ett lämpligt värde för fordonet bestäms och tillämpas under ruttplaneringen. Ett värde som inte är noll kan åsidosättas under routningsplaneringen. Det aktuella trafikflödet är till exempel 60 km/timme. Om fordonets högsta hastighet är inställd på 50 km/timme kommer routningsmotorn att överväga 60 km/timme eftersom detta är den aktuella situationen. Om fordonets högsta hastighet anges som 80 km/timme, men det aktuella trafikflödet är 60 km/timme, använder routningsmotorn återigen 60 km/timme.
weight	integer (int64) minimum: 0 maximum: 1000000	0	Fordonets vikt i kg. Värdet 0 innebär att viktbegränsningar inte beaktas.
width	number (double) minimum: 0 maximum: 1000000	0	Fordonets bredd i meter. Värdet 0 innebär att breddbegränsningar inte beaktas.

RouteOutputOptionEnum

Uppräkning

Inkludera önskad väginformation från svaret. Som standard ingår resplanen i svaret.

Stöder flera värden, till exempel "routeOutputOptions": ["routePath", "regionTravelSummary"]

Värde	Description
itinerary	Inkludera detaljerade anvisningar i svaret. Detaljerade anvisningar tillhandahålls som "ManeuverPoints" och innehåller information som instruktioner för turn-by-turn.
regionTravelSummary	Inkludera resesammanfattning av avstånd, tid och vägtull med två entitetstyper: land (t.ex. USA, Kanada) och administrativ division eller underregion (t.ex. "delstat" i USA och "provins" i Kanada). `Note`: Stöds endast för kör- och gångresorMode
routePath	Inkludera en GeoJSON MultiLineString-RFC 7946, avsnitt 3.1.5 som beskriver vägens sökväg i svaret.
routeSummary	Inkludera endast restid och avstånd för rutten och ange inte annan information.

RoutePathPoint

Objekt

Refererar till indexet för en punkt inom en specifik del av en väg.

Name	Typ	Description
legIndex	integer (int64)	Route Leg-indexet är ett sekventiellt nummer som tilldelats varje del av vägen för att identifiera och skilja mellan olika segment av vägen.
pointIndex	integer (int64)	Index för en punkt inom ett visst ben.

RoutePathProperties

Objekt

Anger de egenskaper som beskriver vägens sökväg i svaret.

Name	Typ	Description
arrivalAt	string (date-time)	Den uppskattade ankomsttiden för benet, som tar hänsyn till trafikförhållandena, formateras som ett `dateTime` värde som definieras av RFC 3339, avsnitt 5.6. Den refererar till tidszonsförskjutningen med antingen `departAt` eller `arrivalAt`. Annars används UTC-tiden.
departureAt	string (date-time)	Den uppskattade avgångstiden för benet, som tar hänsyn till trafikförhållandena, formateras som ett `dateTime` värde som definieras av RFC 3339, avsnitt 5.6. Den refererar till tidszonsförskjutningen med antingen `departAt` eller `arrivalAt`. Annars används UTC-tiden.
distanceInMeters	number	Det fysiska avståndet i mätare som täcks av hela vägen.
durationInSeconds	integer (int64)	Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden.
durationTrafficInSeconds	integer (int64)	Den tid det tar i sekunder att resa en motsvarande `TravelDistance` med aktuella trafikförhållanden. Det här värdet anges om `optimizeRoute` innehåller trafiköverväganden.
legs	Leg[]	En matris med routningsben. Mer information finns i beskrivningen av objektet route Leg.
optimizedWaypoints	OptimizedWaypoint[]	Optimerad sekvens av waypoints. Det visar indexet från den användaringivna waypoint-sekvensen för de ursprungliga och optimerade listorna.
resourceId	string	Ett unikt ID för resursen.
trafficCongestion	TrafficCongestionEnum	Trafikstockningsnivån längs vägen. `Note`: Stöds endast för att köra resorMode
trafficDataUsed	TrafficDataUsedEnum	Typen av trafikdata i realtid som används för att generera vägen.
type	string: RoutePath	Utdatatyp.

RoutePathRange

Objekt

Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

Name	Typ	Description
legIndex	integer (int64)	Route Leg-indexet är ett sekventiellt nummer som tilldelats varje del av vägen för att identifiera och skilja mellan olika segment av vägen.
range	integer[] (int64)	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

RoutePathTravelModeEnum

Uppräkning

Färdsättet för vägsökvägen i svaret.

Värde	Description
driving	Vägar som är optimerade för bilar.
other	RouteTravelMode returneras som "annan" för lastbilen travelMode när lastbilsvägen inte är tillgänglig för en viss del av en väg.
truck	Rutter som är optimerade för stora lastbilar baserat på fordonsspecifikationen.
walking	Vägar som är optimerade för fotgängare.

SideOfStreetEnum

Uppräkning

Sidan av gatan där målet finns baserat på ankomstriktningen. Det här fältet gäller endast för den sista manöverpunkten.

Värde	Description
Left	Vänster.
Right	Höger.
Unknown	Okänt.

Step

Objekt

Ett vägben innehåller instruktioner för sväng-för-sväng. Ett steg refererar till ett intervall av en väg mellan två på varandra följande manövreringspunkter.

Name	Typ	Description
compassDegrees	number	Riktning i grader. `Note`: Stöds endast för att köra travelMode.
maneuverType	ManeuverTypeEnum	Den typ av manöver som beskrivs i den här detaljerade samlingen. ManeuverType innehåller information om en del av manövern som anges i motsvarande instruktion. Till exempel kan maneuverType för en instruktion ange TurnLeftThenTurnRight, medan de associerade detaljobjekten kan ge detaljer om TurnLeft- och TurnRight-manövrarna
names	string[]	En gata, motorväg eller korsning där manövern sker. Om manövern är komplex kan det finnas fler än ett namnfält i informationssamlingen. Namnfältet kanske inte heller har något värde. Detta kan inträffa om namnet inte är känt eller om en gata, motorväg eller korsning inte har något namn.
roadType	RoadTypeEnum	Typ av väg. `Note`: Stöds endast för att köra travelMode.
routePathRange	RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

SubLeg

Objekt

Information om ett segment av routningsbenet som definieras av vägbensvägpunkterna och eventuella mellanliggande viavägspunkter. Om vägen Leg till exempel har två viavägspunkter utöver start- och slutvägspunkter skulle det finnas tre (3) routningsunderben.

Name	Typ	Description
distanceInMeters	number	Det fysiska avståndet i mätare som täcks av underbenet.
durationInSeconds	integer (int64)	Uppskattad restid i sekunder som inte inkluderar fördröjningar på vägen på grund av trafikförhållanden.
durationTrafficInSeconds	integer (int64)	Den tid det tar i sekunder att resa en motsvarande `TravelDistance` med aktuella trafikförhållanden. Det här värdet anges om `optimizeRoute` innehåller trafiköverväganden.
routePathRange	RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

Summary

Objekt

Sammanfattning av batchbegäran

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

TrafficCongestionEnum

Uppräkning

Trafikstockningsnivån längs vägen. Note: Stöds endast för att köra resorMode

Värde	Description
Heavy	Tung.
Medium	Medium.
Mild	Mild.
None	Ingen.
Unknown	Okänt.

TrafficDataUsedEnum

Uppräkning

Typen av trafikdata i realtid som används för att generera vägen.

Värde	Description
Closure	Data om stängning i realtid används, om tillämpligt.
Flow	Realtidstrafikhastigheter som används för att beräkna restiden.
FlowAndClosure	Flöde och stängning.
None	Ingen.

TravelModeEnum

Uppräkning

Färdsätt för den begärda vägen. Om det inte definieras är standardvärdet "körning" som returnerar den väg som är optimerad för bilar.

Note: För lastbilsresorMode kanske den begärda lastbilsvägen inte är tillgänglig för hela vägen. Om lastbilsvägen inte är tillgänglig för ett visst avsnitt är travelMode-elementet i svaret för det avsnittet "annat".

Exempel: "travelMode":"driving"

Värde	Description
driving	De returnerade vägarna är optimerade för bilar.
truck	De returnerade vägarna är optimerade för stora lastbilar baserat på fordonsspecifikationen.
walking	De returnerade vägarna är optimerade för fotgängare, inklusive användning av trottoarer.

VehicleLoadTypeEnum

Uppräkning

Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder. vehicleLoadType stöder flera värden i en begäran.

Värde	Description
USHazmatClass1	Sprängämnen
USHazmatClass2	Komprimerad gas
USHazmatClass3	Brandfarliga vätskor
USHazmatClass4	Brandfarliga fasta ämnen
USHazmatClass5	Oxidatorer
USHazmatClass6	Gifter
USHazmatClass7	Radioaktiv
USHazmatClass8	Frätande
USHazmatClass9	Diverse
otherHazmatExplosive	Sprängämnen
otherHazmatGeneral	Diverse
otherHazmatHarmfulToWater	Skadligt för vatten

ViaWaypointProperties

Objekt

Anger egenskaperna för en ViaWaypoint som är en vägpunkt som måste skickas genom eller besökas längs en väg eller resa.

Name	Typ	Description
names	string[]	En gata, motorväg eller korsning där manövern sker. Om manövern är komplex kan det finnas fler än ett namnfält i informationssamlingen. Namnfältet kanske inte heller har något värde. Detta kan inträffa om namnet inte är känt eller om en gata, motorväg eller korsning inte har något namn.
order	Order	Sekvens för att besöka waypoints och viaWaypoints.
routePathPoint	RoutePathPoint	Refererar till indexet för en punkt inom en specifik del av en väg.
type	string: ViaWaypoint	Utdatatyp.

WaypointProperties

Objekt

Anger egenskaperna för en vägpunkt som är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.

Name	Typ	Standardvärde	Description
address	Address		Resultatets adress. `Note`: Stöds endast för truck travelMode.
compassDirection	string		Färdriktningen i samband med en manöver på en väg, till exempel söder eller sydväst. `Note`: Stöds endast för att köra travelMode.
distanceInMeters	number		Det fysiska avståndet i mätare som omfattas av det här vägsteget.
durationInSeconds	integer (int64)		Den tid det tar i sekunder att resa en motsvarande `TravelDistance`.
exitIdentifier	string		Namnet eller numret på avslutet som är associerat med det här vägsteget.
instruction	Instruction		En beskrivning av en manöver i en uppsättning riktningar.
order	Order		Sekvens för att besöka waypoints och viaWaypoints.
routePathPoint	RoutePathPoint		Refererar till indexet för en punkt inom en specifik del av en väg.
sideOfStreet	SideOfStreetEnum		Sidan av gatan där målet finns baserat på ankomstriktningen. Det här fältet gäller endast för den sista manöverpunkten.
signs	string[]		Skyltningstext för vägen. Det kan finnas fler än ett teckenvärde.
steps	Step[]		Steg mellan två på varandra följande manöverpunkter.
towardsRoadName	string		Namnet på gatan som vägen går mot i den första `ManeuverPoint`.
travelMode	RoutePathTravelModeEnum	driving	Färdsättet för vägsökvägen i svaret.
type	string: Waypoint		Utdatatyp.

Dela via

Route - Post Route Directions Batch

Skicka synkron Batch-begäran

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

Batch-svarsmodell

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

AADToken

Omfattningar

subscription-key

SAS Token

Exempel

A Route Directions Batch request containing 2 queries

Exempelbegäran

Exempelsvar

Definitioner

Address

AdminDistrict

AdminDistricts

AdrTunnelRestrictionCodeEnum

AvoidEnum

CountryRegion

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

DrivingSideEnum

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointProperties

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizedWaypoint

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteDirectionOptimizeRouteEnum

RouteDirectionVehicleSpec

RouteOutputOptionEnum

RoutePathPoint

RoutePathProperties

RoutePathRange

RoutePathTravelModeEnum

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelModeEnum

VehicleLoadTypeEnum

ViaWaypointProperties

WaypointProperties

Ytterligare resurser