Route - Post Route Directions

Tjänst:: Maps

API-version:: 2025-01-01

Använd för att få den bästa vägen mellan ett ursprung och destination för bilar, kommersiella lastbilar och vandringsleder.
API:et Route Directions är en HTTP-POST begäran som returnerar den perfekta vägen mellan ett ursprung och mål för bil (körning), kommersiella lastbilar och gångvägar. Vägen passerar genom en serie vägpunkter om den anges. En vägpunkt är en geografisk plats som definieras av longitud och latitud som används i navigeringssyfte. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda veckodagen och tiden på dagen.

API:et returnerar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Mer routningsinformation, till exempel en optimerad vägpunktsordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka parametrar som används.

Route Directions tar hänsyn till lokala lagar, fordonsdimensioner, lasttyp, maxhastighet, bro- och tunnelhöjder för att beräkna lastbilsspecifika vägar och undvika komplexa manövrar och svåra vägar. Alla lastbilar kan inte färdas på samma vägar som andra fordon på grund av vissa begränsningar som baseras på fordonsprofilen eller lasttypen. Till exempel har motorvägar ofta separata hastighetsgränser för lastbilar, vissa vägar tillåter inte lastbilar med brandfarliga eller farliga material, och det kan finnas höjd- och viktbegränsningar på broar.

Upp till 150 waypoints och 10 viaWaypoints mellan två olika waypoints stöds. Varje uppsättning waypoints skapar en separat väg leg. ViaWaypoints definierar vägsökvägen och kan användas för att skapa vägar via specifika platser, men de skapar inte routningsben.

För information om rutttillgänglighet i länder/regioner, se Azure Maps routingtäckning.

POST {endpoint}/route/directions?api-version=2025-01-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Media Types: "application/geo+json"

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.
Accept-Language		string	Språk där routningsresultat ska returneras. För mer information, se Lokaliseringsstöd i Azure Maps.

Name

Obligatorisk

Typ

Description

x-ms-client-id

string

Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

Accept-Language

string

Språk där routningsresultat ska returneras.

För mer information, se Lokaliseringsstöd i Azure Maps.

Begärandetext

Media Types: "application/geo+json"

Name	Obligatorisk	Typ	Description
features	True	InputWaypointFeaturesItem[]	Kör-, gång- och lastbilsrutter definieras av en uppsättning waypoints (stopp) och viaWaypoints (mellanliggande platser som vägen måste passera igenom). Du kan ha högst 150 waypoints och högst 10 viaWaypoints mellan varje uppsättning waypoints. 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.
type	True	FeatureTypeEnum	Anger `GeoJSON` typ. Den enda objekttypen som stöds är `FeatureCollection`. Mer information finns i RFC 7946.
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. Example: "departAt": "2023-06-01T09:30:00.000-07:00"
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.
maxRouteCount		integer (int64) minimum: 1 maximum: 6	Det maximala antalet vägar som ska returneras. Tillgänglig för kör- och lastbilstransportlägen. Standard: "maxRouteCount":1
optimizeRoute		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":"kortaste"
optimizeWaypointOrder		boolean	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.
routeOutputOptions		RouteOutputOptionEnum[]	Inkludera önskad väginformation från svaret. Som standard ingår resplanen i svaret. Stöder flera värden, till exempel "routeOutputOptions": ["routePath", "itinerary"]
travelMode		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"
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

Svar

Name	Typ	Description
200 OK	RouteDirectionsResponse	Begäran har slutförts. Media Types: "application/geo+json", "application/json"
Other Status Codes	MapsErrorResponse	Ett oväntat felsvar. Media Types: "application/geo+json", "application/json"

Name

Typ

Description

200 OK

RouteDirectionsResponse

Begäran har slutförts.

Media Types: "application/geo+json", "application/json"

Other Status Codes

MapsErrorResponse

Ett oväntat felsvar.

Media Types: "application/geo+json", "application/json"

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Varje användare, grupp eller tjänstehuvudperson kan beviljas åtkomst via en inbyggd roll eller en anpassad roll bestående av en eller flera behörigheter för att Azure Maps REST-API:er.\n\nFör att implementera scenarier rekommenderar vi att man tittar på autentiseringskoncept. Sammanfattningsvis erbjuder denna säkerhetsdefinition en lösning för modellering av applikationer via objekt som kan åtkomstkontroll på specifika API:er och scopes.\n\n#### Anteckningar\n* Denna säkerhetsdefinition kräver användning av x-ms-client-id-headern för att ange vilken Azure Maps resurs applikationen begär åtkomst till. Detta kan hämtas från Maps management API.\n* \nAuthorization URL är specifik för den Azure publika molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. \n* \nDen Azure rollbaserade åtkomstkontrollen konfigureras från Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST API:er.\n* \nAnvändning av Azure Maps Web SDK möjliggör konfigurationsbaserad installation av en applikation för flera användningsområden.\n* För mer information om Microsofts identitetsplattform, se Microsofts identitetsplattform översikt.

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

Omfattningar

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

subscription-key

Detta är en delad nyckel som provisioneras när du Skapa ett Azure Maps-konto i Azure-portalen eller med PowerShell, CLI, Azure-SDK:er eller REST API.\n\n Med denna nyckel kan vilken applikation som helst komma åt alla REST API:er. Med andra ord kan denna nyckel användas som en huvudnyckel i det konto där de utfärdas.\n\n För offentligt exponerade applikationer rekommenderar vi att använda konfidentiella klientapplikationer för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras säkert.

Typ: apiKey
I: header

SAS Token

Detta är en delad åtkomstsignaturtoken som skapas från List SAS-operationen på Azure Maps-resursen via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST-API:er.\n\n Med denna token är varje applikation auktoriserad att få åtkomst med Azure rollbaserade åtkomstkontroller och finkornig kontroll till utgångsdatum, hastighet och region(er) för användning för den specifika token. Med andra ord kan SAS-token användas för att låta applikationer kontrollera åtkomsten på ett säkrare sätt än den delade nyckeln.\n\n För offentligt exponerade applikationer är vår rekommendation att konfigurera en specifik lista över tillåtna ursprung på Map-kontots resurs för att begränsa renderingsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Exempelbegäran

HTTP

POST {endpoint}/route/directions?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201399,
          47.608678
        ]
      },
      "properties": {
        "pointIndex": 0,
        "pointType": "waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20687,
          47.612002
        ]
      },
      "properties": {
        "pointIndex": 1,
        "pointType": "viaWaypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "pointIndex": 2,
        "pointType": "waypoint"
      }
    }
  ],
  "maxRouteCount": 3,
  "optimizeRoute": "fastestWithTraffic",
  "routeOutputOptions": [
    "routePath"
  ],
  "travelMode": "driving"
}

Exempelsvar

Statuskod:: 200

{
  "type": "FeatureCollection",
  "alternativeRoutes": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.20147,
              47.60868
            ]
          },
          "properties": {
            "type": "Waypoint",
            "order": {
              "inputIndex": 0
            },
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 0
            }
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.2016,
              47.61508
            ]
          },
          "properties": {
            "type": "Waypoint",
            "order": {
              "inputIndex": 1
            },
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 29
            }
          }
        },
        {
          "type": "Feature",
          "bbox": [
            -122.2016,
            47.60868,
            -122.20145,
            47.61508
          ],
          "geometry": {
            "type": "MultiLineString",
            "coordinates": [
              [
                [
                  -122.20147,
                  47.60868
                ],
                [
                  -122.20148,
                  47.60884
                ],
                [
                  -122.20148,
                  47.60906
                ],
                [
                  -122.20148,
                  47.60919
                ],
                [
                  -122.20148,
                  47.60953
                ],
                [
                  -122.20148,
                  47.60967
                ],
                [
                  -122.20149,
                  47.60997
                ],
                [
                  -122.2015,
                  47.61011
                ],
                [
                  -122.2015,
                  47.61019
                ],
                [
                  -122.20151,
                  47.61072
                ],
                [
                  -122.20152,
                  47.61092
                ],
                [
                  -122.20152,
                  47.61097
                ],
                [
                  -122.20149,
                  47.611
                ],
                [
                  -122.20147,
                  47.61104
                ],
                [
                  -122.20145,
                  47.61117
                ],
                [
                  -122.20145,
                  47.61122
                ],
                [
                  -122.20145,
                  47.61126
                ],
                [
                  -122.20146,
                  47.61149
                ],
                [
                  -122.20147,
                  47.61166
                ],
                [
                  -122.20148,
                  47.61197
                ],
                [
                  -122.20148,
                  47.61203
                ],
                [
                  -122.2015,
                  47.61268
                ],
                [
                  -122.20151,
                  47.61289
                ],
                [
                  -122.20152,
                  47.61297
                ],
                [
                  -122.20153,
                  47.61338
                ],
                [
                  -122.20155,
                  47.61386
                ],
                [
                  -122.20158,
                  47.61464
                ],
                [
                  -122.20159,
                  47.61475
                ],
                [
                  -122.2016,
                  47.61503
                ],
                [
                  -122.2016,
                  47.61508
                ]
              ]
            ]
          },
          "properties": {
            "type": "RoutePath",
            "arrivalAt": "2025-06-17T09:09:40+00:00",
            "departureAt": "2025-06-17T09:08:10+00:00",
            "distanceInMeters": 713,
            "durationInSeconds": 92,
            "durationTrafficInSeconds": 90,
            "legs": [
              {
                "arrivalAt": "2025-06-17T09:09:40+00:00",
                "departureAt": "2025-06-17T09:08:10+00:00",
                "distanceInMeters": 713,
                "durationInSeconds": 92,
                "durationTrafficInSeconds": 90,
                "routePathRange": {
                  "legIndex": 0,
                  "range": [
                    0,
                    29
                  ]
                }
              }
            ],
            "trafficCongestion": "Medium"
          }
        }
      ]
    }
  ],
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.60868
        ]
      },
      "properties": {
        "type": "Waypoint",
        "order": {
          "inputIndex": 0
        },
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        }
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.2016,
          47.61508
        ]
      },
      "properties": {
        "type": "Waypoint",
        "order": {
          "inputIndex": 2
        },
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 64
        }
      }
    },
    {
      "type": "Feature",
      "bbox": [
        -122.20697,
        47.60868,
        -122.20147,
        47.61508
      ],
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.60868
            ],
            [
              -122.20148,
              47.60884
            ],
            [
              -122.20148,
              47.60906
            ],
            [
              -122.20148,
              47.60919
            ],
            [
              -122.20148,
              47.60953
            ],
            [
              -122.20148,
              47.60967
            ],
            [
              -122.20149,
              47.60997
            ],
            [
              -122.2015,
              47.61011
            ],
            [
              -122.2015,
              47.61019
            ],
            [
              -122.20192,
              47.61021
            ],
            [
              -122.20199,
              47.61021
            ],
            [
              -122.20252,
              47.61019
            ],
            [
              -122.20264,
              47.61018
            ],
            [
              -122.20271,
              47.61015
            ],
            [
              -122.20276,
              47.61015
            ],
            [
              -122.20281,
              47.61015
            ],
            [
              -122.20286,
              47.61015
            ],
            [
              -122.20329,
              47.61016
            ],
            [
              -122.20346,
              47.61016
            ],
            [
              -122.20414,
              47.61017
            ],
            [
              -122.20416,
              47.61057
            ],
            [
              -122.20418,
              47.61083
            ],
            [
              -122.20418,
              47.61092
            ],
            [
              -122.20419,
              47.61103
            ],
            [
              -122.20419,
              47.61121
            ],
            [
              -122.2042,
              47.61126
            ],
            [
              -122.20478,
              47.61127
            ],
            [
              -122.20555,
              47.61128
            ],
            [
              -122.20569,
              47.61128
            ],
            [
              -122.20596,
              47.61128
            ],
            [
              -122.20617,
              47.61127
            ],
            [
              -122.20624,
              47.61125
            ],
            [
              -122.2066,
              47.61126
            ],
            [
              -122.20669,
              47.61127
            ],
            [
              -122.20686,
              47.61129
            ],
            [
              -122.20687,
              47.61158
            ],
            [
              -122.20689,
              47.61187
            ],
            [
              -122.20691,
              47.61233
            ],
            [
              -122.20691,
              47.61247
            ],
            [
              -122.20694,
              47.61317
            ],
            [
              -122.20695,
              47.61342
            ],
            [
              -122.20696,
              47.61362
            ],
            [
              -122.20697,
              47.61384
            ],
            [
              -122.20683,
              47.61384
            ],
            [
              -122.20638,
              47.61384
            ],
            [
              -122.20612,
              47.61384
            ],
            [
              -122.20568,
              47.61383
            ],
            [
              -122.20559,
              47.6138
            ],
            [
              -122.20467,
              47.61379
            ],
            [
              -122.20443,
              47.61379
            ],
            [
              -122.20405,
              47.61379
            ],
            [
              -122.20325,
              47.6138
            ],
            [
              -122.203,
              47.6138
            ],
            [
              -122.20274,
              47.6138
            ],
            [
              -122.20241,
              47.61381
            ],
            [
              -122.20222,
              47.6138
            ],
            [
              -122.20202,
              47.6138
            ],
            [
              -122.20193,
              47.6138
            ],
            [
              -122.20181,
              47.61386
            ],
            [
              -122.20167,
              47.61386
            ],
            [
              -122.20155,
              47.61386
            ],
            [
              -122.20158,
              47.61464
            ],
            [
              -122.20159,
              47.61475
            ],
            [
              -122.2016,
              47.61503
            ],
            [
              -122.2016,
              47.61508
            ]
          ]
        ]
      },
      "properties": {
        "type": "RoutePath",
        "arrivalAt": "2025-06-17T09:13:10+00:00",
        "departureAt": "2025-06-17T09:08:10+00:00",
        "distanceInMeters": 1520,
        "durationInSeconds": 307,
        "durationTrafficInSeconds": 300,
        "legs": [
          {
            "arrivalAt": "2025-06-17T09:13:10+00:00",
            "departureAt": "2025-06-17T09:08:10+00:00",
            "distanceInMeters": 1520,
            "durationInSeconds": 307,
            "durationTrafficInSeconds": 300,
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                64
              ]
            }
          }
        ],
        "trafficCongestion": "Medium"
      }
    }
  ]
}

Definitioner

Name	Description
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.
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ödjer flera värden i en förfrågan och stöds endast för kör- och lastbilsresläget.\n\nExempel: "undvik": ["limitedAccessHighways", "tollRoads"]
CountryRegion	Representerar ett land eller en region som innehåller relaterad information.
DirectionsRequest	Det här objektet är begärandetexten.
DrivingSideEnum	Anger vänster eller höger sida körning vid tidpunkten för manövern.
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.
GeoJsonObjectType	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
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.
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 feldetaljer för misslyckade operationer.
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.
NavigationPointPropertiesAddress	Det administrativa distriktet och landsregionen för waypoints och manöverpunkter på rutten.
OptimizedWaypoint	Optimerat vägpunktsobjekt.
Order	Sekvens för att besöka waypoints.
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.
PropertiesTypeEnum	Typ av utdata.
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":"kortaste"
RouteDirectionsResponse	Alternativ väg.
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.
RouteLeg	Information om ett avsnitt av en väg mellan två vägpunkter. Mer information om fälten som finns i en väg leg:
RouteOutputOptionEnum	Den önskade ruttinformationen från svaret.
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.
RouteStep	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.
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.
TrafficCongestionEnum	Trafikstockningsnivån längs vägen. `Note`: Stöds endast för att köra resorMode
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.
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.

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
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ödjer flera värden i en förfrågan och stöds endast för kör- och lastbilsresläget.\n\nExempel: "undvik": ["limitedAccessHighways", "tollRoads"]

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

CountryRegion

Objekt

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

Name	Typ	Description
ISO	string	ISO för land/region representerar en ISO 3166-1 Alpha-2-region/landskod
name	string	namn på land/region

DirectionsRequest

Objekt

Det här objektet är begärandetexten.

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. Example: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		Kör-, gång- och lastbilsrutter definieras av en uppsättning waypoints (stopp) och viaWaypoints (mellanliggande platser som vägen måste passera igenom). Du kan ha högst 150 waypoints och högst 10 viaWaypoints mellan varje uppsättning waypoints. 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.
maxRouteCount	integer (int64) minimum: 1 maximum: 6		Det maximala antalet vägar som ska returneras. Tillgänglig för kör- och lastbilstransportlägen. Standard: "maxRouteCount":1
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":"kortaste"
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.
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", "itinerary"]
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

DrivingSideEnum

Uppräkning

Anger vänster eller höger sida körning vid tidpunkten för manövern.

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

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

GeoJsonObjectType

Uppräkning

Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Värde	Description
Point	`GeoJSON Point` geometri.
MultiPoint	`GeoJSON MultiPoint` geometri.
LineString	`GeoJSON LineString` geometri.
MultiLineString	`GeoJSON MultiLineString` geometri.
Polygon	`GeoJSON Polygon` geometri.
MultiPolygon	`GeoJSON MultiPolygon` geometri.
GeometryCollection	`GeoJSON GeometryCollection` geometri.
Feature	`GeoJSON Feature` objekt.
FeatureCollection	`GeoJSON FeatureCollection` objekt.

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 två första elementen är longitud och latitud, exakt i den ordningen. Höjd/Höjd ä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.

InputWaypointFeaturesItem

Objekt

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

Name	Typ	Description
geometry	GeoJsonPoint	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
waypoint	En vägpunkt är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.
viaWaypoint	En viaWaypoint är en specifik vägpunkt som måste skickas genom eller besökas längs en väg eller resa.

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.
formattedText	string	Instruktionens formaterade textbeskrivning.
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.

ManeuverPointProperties

Objekt

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

Name	Typ	Standardvärde	Description
address	NavigationPointPropertiesAddress		Det administrativa distriktet och landsregionen för waypoints och manöverpunkter på rutten.
distanceInMeters	number (float)		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.
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	RouteStep[]		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		Typ av utdata.

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 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	Var höger.
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
DepartStart	Lämna startpunkten.
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å.
EnterRoundabout	Ange en rondell.
ExitRoundabout	Avsluta en rondell.
EnterThenExitRoundabout	Ange och avsluta en rondell.
ExitRoundaboutRight	Vid rondellen tar du avfarten till höger.
ExitRoundaboutLeft	Vid rondellen tar du avfarten till vänster.
Follow	Follow.
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.
SwitchToParallelRoad	Växla till den parallella vägen.
SwitchToMainRoad	Byt till huvudvägen.
Take	Ta vägen. Den här instruktionen används när du går in i eller lämnar en färja.
TakeFerry	Ta färjan.
TakeExit	Ta avslutet.
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.
Unknown	Instruktionen är okänd.
UTurn	Gör en u-sväng för att gå i motsatt riktning.
Wait	Wait
Walk	Walk

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 feldetaljer för misslyckade operationer.

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.

NavigationPointPropertiesAddress

Objekt

Det administrativa distriktet och landsregionen för waypoints och manöverpunkter på rutten.

Name	Typ	Description
adminDistricts	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.
countryRegion	CountryRegion	Representerar ett land eller en region som innehåller relaterad information.

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.

Name	Typ	Description
inputIndex	integer (int64)	Index som tillhandahålls av användare för waypoint
optimizedIndex	integer (int64)	Systemoptimerad waypoint

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 två första elementen är longitud och latitud, exakt i den ordningen. Höjd/Höjd ä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.

PropertiesTypeEnum

Uppräkning

Typ av utdata.

Värde	Description
ManeuverPoint	En maneuverPoint är en specifik punkt på en rutt eller resa där en ändring av riktning eller transportmedel krävs eller rekommenderas.
Waypoint	En vägpunkt är en specifik plats eller punkt längs en väg eller resa som fungerar som referens eller stopppunkt.
RoutePath	En routePath är en linje som representerar vägen för en rutt eller resa.

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":"kortaste"

Värde	Description
short	Rutten är beräknad för att balansera snabb restid och korta avstånd, snarare än att bara prioritera en. Den är optimerad för både hastighet och effektivitet. Trafikinformation används inte.
shortest	Vägen beräknas för att minimera avståndet. Trafikinformation används inte.
fastestWithoutTraffic	Hittar den snabbaste vägen, utan att ta hänsyn till trafikinformation.
fastestWithTraffic	Vägen beräknas för att minimera tiden med aktuell trafikinformation. `Note`: Stöds endast för körning och lastbilsresorMode.

RouteDirectionsResponse

Objekt

Alternativ väg.

Name	Typ	Description
alternativeRoutes	FeatureCollection[]	Alternativ väg.
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.

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.

RouteLeg

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.
distanceInMeters	number (float)	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.
routePathRange	RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

RouteOutputOptionEnum

Uppräkning

Den önskade ruttinformationen från svaret.

Värde	Description
routeSummary	Inkludera endast restid och avstånd för rutten och ange inte annan information.
routePath	Inkludera en GeoJSON MultiLineString-RFC 7946, avsnitt 3.1.5 som beskriver vägens sökväg i svaret.
itinerary	Inkludera detaljerade anvisningar i svaret. Detaljerade anvisningar tillhandahålls som "ManeuverPoints" och innehåller information som instruktioner för turn-by-turn.

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 (float)	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	RouteLeg[]	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.
trafficCongestion	TrafficCongestionEnum	Trafikstockningsnivån längs vägen. `Note`: Stöds endast för att köra resorMode
type	string: RoutePath	Typ av utdata.

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.
truck	Rutter som är optimerade för stora lastbilar baserat på fordonsspecifikationen.
walking	Vägar som är optimerade för fotgängare.
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.

RouteStep

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
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.
routePathRange	RoutePathRange	Refererar till det intervall som omfattas av en specifik del av en väg eller sökväg.

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	Left.
Right	Right.
Unknown	Unknown.

TrafficCongestionEnum

Uppräkning

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

Värde	Description
Unknown	Unknown.
None	None.
Mild	Mild.
Medium	Medium.
Heavy	Heavy.

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.

Värde	Description
USHazmatClass1	Explosives
USHazmatClass2	Komprimerad gas
USHazmatClass3	Brandfarliga vätskor
USHazmatClass4	Brandfarliga fasta ämnen
USHazmatClass5	Oxidizers
USHazmatClass6	Poisons
USHazmatClass7	Radioactive
USHazmatClass8	Corrosives
USHazmatClass9	Miscellaneous
otherHazmatExplosive	Explosives
otherHazmatGeneral	Miscellaneous
otherHazmatHarmfulToWater	Skadligt för vatten

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	NavigationPointPropertiesAddress		Det administrativa distriktet och landsregionen för waypoints och manöverpunkter på rutten.
distanceInMeters	number (float)		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.
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	RouteStep[]		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		Typ av utdata.

Dela via

Route - Post Route Directions

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

AadToken

Omfattningar

subscription-key

SAS Token

Exempel

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Exempelbegäran

Exempelsvar

Definitioner

AdminDistrict

AdrTunnelRestrictionCodeEnum

AvoidEnum

CountryRegion

DirectionsRequest

DrivingSideEnum

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonObjectType

GeoJsonPoint

InputWaypointFeaturesItem

InputWaypointProperties

InputWaypointTypeEnum

Instruction

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

NavigationPointPropertiesAddress

OptimizedWaypoint

Order

PointGeometry

PropertiesTypeEnum

RouteDirectionOptimizeRouteEnum

RouteDirectionsResponse

RouteDirectionVehicleSpec

RouteLeg

RouteOutputOptionEnum

RoutePathPoint

RoutePathProperties

RoutePathRange

RoutePathTravelModeEnum

RouteStep

SideOfStreetEnum

TrafficCongestionEnum

TravelModeEnum

VehicleLoadTypeEnum

WaypointProperties