Route - Post Directions Batch

Reference

Service:: Maps

API Version:: 2023-10-01-preview

Use to send a batch of queries to the Route Directions API in a single synchronous request.

The Route Directions Batch API is an HTTP POST request that sends batches of up to 100 queries in a single call to the Route Directions API.

Important

By using this feature, you agree to the preview legal terms. See the Preview Supplemental Terms for additional details.

Submit Synchronous Batch Request

The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to 100 for this API.

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

POST Body for Batch Request

To send the directions queries you will use a POST request where the request body will contain the batchItems array in json format and the Content-Type header will be set to application/json. Here's a sample request body containing 2 directions queries:

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

A directions batchItem object can accept any of the supported directions Request body

The batch should contain at least 1 query.

Batch Response Model

The batch response contains a summary component that indicates the totalRequests that were part of the original batch request and successfulRequests i.e. queries which were executed successfully. The batch response also includes a batchItems array which contains a response for each and every query in the batch request. The batchItems will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:

DirectionsResponse - If the query completed successfully.
Error - If the query failed. The response will contain a code and a message in this case.

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version number of Azure Maps API.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Request Body

Name	Type	Description
batchItems	DirectionsBatchRequestItem[]	The list of queries to process.

Responses

Name	Type	Description
200 OK	DirectionsBatchResponse	Batch request successfully processed. The response body contains all the batch results.
Other Status Codes	DirectionsBatchResponse	Multi-Status. One or more batch items could not be processed and return different status code.
Other Status Codes	MapsErrorResponse	An unexpected error occurred. Headers x-ms-error-code: string

Name

Type

Description

200 OK

DirectionsBatchResponse

Batch request successfully processed. The response body contains all the batch results.

Other Status Codes

DirectionsBatchResponse

Multi-Status. One or more batch items could not be processed and return different status code.

Other Status Codes

MapsErrorResponse

An unexpected error occurred.

Headers

x-ms-error-code: string

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations.
The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
For more information on Microsoft identity platform, see Microsoft identity platform overview.

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

Scopes

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

subscription-key

This is a shared key that is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.

For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: header

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

A Route Directions Batch request containing 2 queries

Sample request

HTTP

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

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

Sample response

Status code:: 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"
    }
  ]
}

Status code:: 207

{
  "summary": {
    "successfulRequests": 1,
    "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"
    },
    {
      "error": {
        "code": "400 BadRequest",
        "message": "Invalid request"
      }
    }
  ]
}

Definitions

Name	Description
AdminDistrict	The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region.
Avoid	Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. Example: "avoid": ["limitedAccessHighways", "tolls"]
DirectionsBatchRequestBody	The list of directions queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.
DirectionsBatchRequestItem	Batch Query object
DirectionsBatchResponse	This object is returned from a successful Directions Batch service call.
DirectionsBatchResponseItem	Batch response item
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
FeatureCollection	`GeoJSON` `FeatureCollection` object that contains a list of Features. For more information, see RFC 7946, section 3.3.
FeaturesItem	GeoJSON feature object that contains Geometry object and additional properties of the route.
FeaturesItemTypeEnum	Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see RFC 7946.
FeatureTypeEnum	Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see RFC 7946.
GeoJsonPoint	A valid `GeoJSON Point` geometry type. Please refer to RFC 7946 for details.
Hint	Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element. `Note`: Only supported for driving travelMode.
InputWaypointFeaturesItem	Specifies the input waypoint and viaWaypoint `GeoJSON` feature object and additional properties. For more information, see RFC 7946.
InputWaypointTypeEnum	Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through.
Instruction	A description of a maneuver in a set of directions.
Leg	Information about a section of a route between two waypoints. More information about the fields contained in a route Leg:
ManeuverPointProperties	Specifies the driving instructions and additional properties for each maneuver point in the route Leg.
ManeuverTypeEnum	The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.
MapsErrorDetail	The error detail.
MapsErrorResponse	Common error response for Azure Maps APIs to return error details for failed operations.
MapsInnerError	An object containing more specific information than the current object about the error.
MultiLineStringGeometry	Specifies the `GeoJSON` MultiLineString Geometry object. For more information, see RFC 7946.
OptimizeRoute	Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest"
Order	Sequence for visiting waypoints and viaWaypoints.
PointGeometry	Specifies the `GeoJSON` Point Geometry object. For more information, see RFC 7946.
RegionTravelSummary	Travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).
RoadTypeEnum	The type of road. `Note`: Only supported for driving travelMode.
RouteOutputOption	Include the desired route information from the response. By default, the itinerary is included in the response. Supports multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"]
RoutePathPoint	Refers to the index of a point within a specific Leg of a route.
RoutePathProperties	Specifies the properties that describe the route's path in the response.
RoutePathRange	Refers to the range covered by a specific Leg of a route or path.
RouteTravelMode	The mode of travel for the route path in the response.
SideOfStreetEnum	The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.
Step	A route Leg contain turn-by-turn instructions. A step refers to a range of a route between two consecutive maneuverPoint.
SubLeg	Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.
Summary	Summary for the batch request
TrafficCongestionEnum	The level of traffic congestion along the route. `Note`: Only supported for driving travelMode
TrafficDataUsedEnum	The type of real-time traffic data used to generate the route.
TravelMode	The mode of travel for the requested route. If not defined, the default value is "driving" that returns the route optimized for cars. `Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be "other". Example: "travelMode":"driving"
VehicleLoadType	Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request.
VehicleSpec	Vehicle attributes are specified inside of a vehicleSpec. Different regions may have different definitions for the truck classification and types, e.g., light truck, medium truck, heavy truck, etc. To get the most accurate results of the route restrictions based on the truck specs, specify the vehicle attributes. `Note`: Only supported for truck travelMode.
ViaWaypointProperties	Specifies the properties of a `ViaWaypoint` which is a waypoint that must be passed through or visited along a route or trip.
WaypointProperties	Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.

AdminDistrict

The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region.

Name	Type	Description
distanceInMeters	number	The total distance traveled in meters within the administrative district.
durationInSeconds	integer	Estimated travel time in seconds that does not include delays on the route due to traffic conditions.
durationTrafficInSeconds	integer	The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.
longName	string	The long name of an address, such as Washington.

Avoid

Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.

Example: "avoid": ["limitedAccessHighways", "tolls"]

Name	Type	Description
borderCrossings	string	Avoids crossing country borders in the route.
ferries	string	Avoids the use of ferries in the route.
limitedAccessHighways	string	Avoids the use of limited access highways in the route.
lowEmissionZones	string	Avoids low-emission zones in the route. `Note`: Only supported for truck travelMode.
tollRoads	string	Avoids the use of toll roads in the route.
tunnels	string	Avoids the use of tunnels in the route. `Note`: Only supported for truck travelMode.
unpavedRoads	string	Avoids unpaved roads in the route. `Note`: Only supported for truck travelMode.

DirectionsBatchRequestBody

The list of directions queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.

Name	Type	Description
batchItems	DirectionsBatchRequestItem[]	The list of queries to process.

DirectionsBatchRequestItem

Batch Query object

Name	Type	Default value	Description
arriveAt	string		The date and time of arrival at the destination point formatted as a `dateTime` value defined by RFC 3339, section 5.6. When a time zone offset is not specified, UTC will be assumed. The `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`. Example: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid	Avoid[]		Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. Example: "avoid": ["limitedAccessHighways", "tolls"]
departAt	string		The date and time of departure from the origin point formatted as a `dateTime` value defined by RFC 3339, section 5.6. When a time zone offset is not specified, UTC will be assumed. The `departAt` value must be in the future in the date-time format or now value to set it to the current time. Examples: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		Driving and walking routes are defined by a set of waypoints(stops) and viaWaypoints (intermediate locations that the route must pass through). You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. Truck route supports up to 150 waypoints and viaWaypoints are not supported. A route must have a minimum of 2 waypoints and the start and end points of the route cannot be viaWaypoints. Both waypoint and viaWaypoint locations must be specified as a valid GeoJSON Point feature object along with pointIndex that specifies the order of the locations. For more information on the GeoJSON format, see RFC 7946.
heading	integer		The initial directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359
maxRouteCount	integer		The maximum number of routes to return. Available for the driving and truck travel modes. For driving routes, this parameter supports routes with up to two waypoints in addition to the origin and destination and avoid parameter must not be set. Default: "maxRouteCount":1 Minimum: "maxRouteCount":1 Maximum: "maxRouteCount":3
optimizeRoute	OptimizeRoute	fastestWithoutTraffic	Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest"
optimizeWaypointOrder	boolean	False	Re-order the route waypoints using a fast heuristic algorithm to reduce the route cost specified with the optimize parameter. The origin and destination are excluded from the optimized waypoint and their position is considered fixed. Acceptable values are true or false. `Note`: Only supported for truck travelMode.
optionalId	string		Id of the request which would show in corresponding batchItem.
routeOutputOptions	RouteOutputOption[]	[ "itinerary" ]	Include the desired route information from the response. By default, the itinerary is included in the response. Supports multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"]
travelMode	TravelMode	driving	The mode of travel for the requested route. If not defined, the default value is "driving" that returns the route optimized for cars. `Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be "other". Example: "travelMode":"driving"
type	FeatureTypeEnum		Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see RFC 7946.
vehicleSpec	VehicleSpec		Specifies the vehicle attributes such as size, weight, max speed, type of cargo for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications. `Note`: Only supported for truck travelMode

DirectionsBatchResponse

This object is returned from a successful Directions Batch service call.

Name	Type	Description
batchItems	DirectionsBatchResponseItem[]	Array containing the batch results.
nextLink	string	The is the link to the next page of the features returned. If it's the last page, the field will not exist.
summary	Summary	Summary for the batch request

DirectionsBatchResponseItem

Batch response item

Name	Type	Description
alternativeRoutes	FeatureCollection[]	Alternative route.
error	ErrorDetail	The error detail.
features	FeaturesItem[]	`GeoJSON` feature object that contains Geometry object and additional properties. For more information, see RFC 7946, Section 3.2.
nextLink	string	The is the link to the next page of the features returned. If it's the last page, the field will not exist.
optionalId	string	Id of the request which would show in corresponding batchItem.
type	FeatureTypeEnum	Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see RFC 7946.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

FeatureCollection

GeoJSON FeatureCollection object that contains a list of Features. For more information, see RFC 7946, section 3.3.

Name	Type	Description
features	FeaturesItem[]	`GeoJSON` feature object that contains Geometry object and additional properties. For more information, see RFC 7946, Section 3.2.
nextLink	string	The is the link to the next page of the features returned. If it's the last page, the field will not exist.
type	FeatureTypeEnum	Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see RFC 7946.

FeaturesItem

GeoJSON feature object that contains Geometry object and additional properties of the route.

Name	Type	Description
bbox	number[]	A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by latitude and longitude values. For more information, see RFC 7946, Section 5. Example: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	Geometry: MultiLineStringGeometry PointGeometry	A valid `GeoJSON` Geometry object. For more information, see RFC 7946.
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	Specifies the feature properties of the route like itinerary, route Legs and geometry, travel summary.
type	FeaturesItemTypeEnum	Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see RFC 7946.

FeaturesItemTypeEnum

Specifies the GeoJSON type. The only supported object type is Feature. For more information, see RFC 7946.

Name	Type	Description
Feature	string	Specifies the `GeoJSON` Feature object type.

FeatureTypeEnum

Specifies the GeoJSON type. The only supported object type is FeatureCollection. For more information, see RFC 7946.

Name	Type	Description
FeatureCollection	string	Specifies the `GeoJSON` `FeatureCollection` object type.

GeoJsonPoint

A valid GeoJSON Point geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	A `Position` is an array of numbers with two or more elements. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type	string: Point	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

Hint

Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element. Note: Only supported for driving travelMode.

Name	Type	Description
hintType	string	hint type.
text	string	hint text.

InputWaypointFeaturesItem

Specifies the input waypoint and viaWaypoint GeoJSON feature object and additional properties. For more information, see RFC 7946.

Name	Type	Default value	Description
geometry	GeoJsonPoint: PointGeometry		A valid `GeoJSON Point` geometry type. Please refer to RFC 7946 for details.
properties.pointIndex	integer		Identify and order the sequence of waypoints in the route. The default value is the `index value` of a features array.
properties.pointType	InputWaypointTypeEnum	waypoint	Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through.
type	FeaturesItemTypeEnum		Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see RFC 7946.

InputWaypointTypeEnum

Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through.

Name	Type	Description
viaWaypoint	string	A viaWaypoint is a specific waypoint that must be passed through or visited along a route or trip. `Note`: Only supported for driving travelMode.
waypoint	string	A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point.

Instruction

A description of a maneuver in a set of directions.

Name	Type	Description
formattedText	string	The formatted text description of the instruction.
hints	Hint[]	Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element and a route step can contain more than one hint. `Note`: Only supported for driving travelMode
maneuverType	ManeuverTypeEnum	The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.
text	string	The plain text description of the instruction.

Leg

Information about a section of a route between two waypoints. More information about the fields contained in a route Leg:

Name	Type	Description
arrivalTime		The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by RFC 3339, section 5.6. It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.
departureTime		The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by RFC 3339, section 5.6. It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.
description	string	A short description of the route.
distanceInMeters	number	The physical distance in meters covered by a route Leg.
durationInSeconds	integer	Estimated travel time in seconds that does not include delays on the route due to traffic conditions.
durationTrafficInSeconds	integer	The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.
regionTravelSummary	RegionTravelSummary	Include travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).
routePathRange	RoutePathRange	Refers to the range covered by a specific Leg of a route or path.
subLegs	SubLeg[]	Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.

ManeuverPointProperties

Specifies the driving instructions and additional properties for each maneuver point in the route Leg.

Name	Type	Default value	Description
compassDirection	string		The direction of travel associated with a maneuver on a route, such as south or southwest. `Note`: Only supported for driving travelMode.
distanceInMeters	number		The physical distance in meters covered by this route step.
durationInSeconds	integer		The time that it takes, in seconds, to travel a corresponding `TravelDistance`.
exitIdentifier	string		The name or number of the exit associated with this route step.
instruction	Instruction		A description of a maneuver in a set of directions.
order	Order		Sequence for visiting waypoints and viaWaypoints.
routePathPoint	RoutePathPoint		Refers to the index of a point within a specific Leg of a route.
sideOfStreet	SideOfStreetEnum		The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.
signs	string[]		Signage text for the route. There may be more than one sign value.
steps	Step[]		Steps between two consecutive maneuver points.
towardsRoadName	string		The name of the street that the route goes towards in the first `ManeuverPoint`.
travelMode	RouteTravelMode	driving	The mode of travel for the route path in the response.
type	string: ManeuverPoint		Output type.

ManeuverTypeEnum

The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.

Name	Type	Description
ArriveFinish	string	Arrive at the final destination.
ArriveIntermediate	string	Arrive at an intermediate waypoint.
BearLeft	string	Bear left.
BearLeftThenBearLeft	string	Bear left and then bear left again.
BearLeftThenBearRight	string	Bear left and then bear right.
BearLeftThenTurnLeft	string	Bear left and then turn left.
BearLeftThenTurnRight	string	Bear left and then turn right.
BearRight	string	Bear right.
BearRightThenBearLeft	string	Bear right and then bear left.
BearRightThenBearRight	string	Bear right and then bear right again.
BearRightThenTurnLeft	string	Bear right and then turn left.
BearRightThenTurnRight	string	Bear right and then turn right.
BearThenKeep	string	Bear instruction and then a keep instruction
BearThenMerge	string	Bear instruction and then a merge instruction.
Continue	string	Continue on the current road.
DepartIntermediateStop	string	Leave an intermediate waypoint in a different direction and road than you arrived on.
DepartIntermediateStopReturning	string	Leave an intermediate waypoint in the same direction and on the same road that you arrived on.
DepartStart	string	Leave the starting point.
EnterRoundabout	string	Enter a roundabout.
EnterThenExitRoundabout	string	Enter and exit a roundabout.
ExitRoundabout	string	Exit a roundabout.
ExitRoundaboutLeft	string	At the roundabout take the exit on the left.
ExitRoundaboutRight	string	At the roundabout take the exit on the right.
Follow	string	Follow.
GoAroundRoundabout	string	Go around the roundabout.
KeepLeft	string	Keep left onto a different road.
KeepOnRampLeft	string	Keep left and continue onto ramp.
KeepOnRampRight	string	Keep right and continue onto ramp.
KeepOnRampStraight	string	Keep straight and continue onto ramp.
KeepRight	string	Keep right onto a different road.
KeepStraight	string	Keep straight onto a different road.
KeepToStayLeft	string	Keep left to stay on the same road.
KeepToStayRight	string	Keep right to stay on the same road.
KeepToStayStraight	string	Keep straight to stay on the same road.
MergeFreeway	string	Merge onto a freeway.
MergeHighway	string	Merge onto a highway.
MergeMotorway	string	Merge onto a motorway.
MotorwayExitLeft	string	Take the left exit.
MotorwayExitRight	string	Take the right exit.
None	string	No instruction.
RampThenHighwayLeft	string	Take left ramp onto highway. This is part of a combined instruction.
RampThenHighwayRight	string	Take right ramp onto highway. This is part of a combined instruction.
RampThenHighwayStraight	string	Stay straight to take ramp onto highway. This is part of a combined instruction.
RoadNameChange	string	Road name changes.
SwitchToMainRoad	string	Switch to the main road.
SwitchToParallelRoad	string	Switch to the parallel road.
Take	string	Take the road. This instruction is used when you are entering or exiting a ferry.
TakeExit	string	Take the exit.
TakeFerry	string	Take the ferry.
TakeRamp	string	Take ramp.
TakeRampLeft	string	Take ramp to the left.
TakeRampRight	string	Take ramp to the right.
TakeRampStraight	string	Stay straight to take ramp.
TurnBack	string	Turn back sharply.
TurnLeft	string	Turn left.
TurnLeftSharp	string	Take a sharp left turn.
TurnLeftThenBearLeft	string	Turn left and then bear left.
TurnLeftThenBearRight	string	Turn left and then bear right.
TurnLeftThenTurnLeft	string	Turn left and then turn left again.
TurnLeftThenTurnRight	string	Turn left and then turn right.
TurnRight	string	Turn right.
TurnRightSharp	string	Take a sharp right turn.
TurnRightThenBearLeft	string	Turn right and then bear left.
TurnRightThenBearRight	string	Turn right and then bear right.
TurnRightThenTurnLeft	string	Turn right and then turn left.
TurnRightThenTurnRight	string	Turn right and then turn right again
TurnThenMerge	string	Turn instruction followed by a merge instruction.
TurnToStayLeft	string	Turn left to stay on the same road.
TurnToStayRight	string	Turn right to stay on the same road.
UTurn	string	Make a u-turn to go in the opposite direction.
Unknown	string	The instruction is unknown.
Wait	string	Wait
Walk	string	Walk

MapsErrorDetail

The error detail.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	MapsErrorDetail[]	An array of details about specific errors that led to this reported error.
innererror	MapsInnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

MapsErrorResponse

Common error response for Azure Maps APIs to return error details for failed operations.

Name	Type	Description
error	MapsErrorDetail	The error detail.

MapsInnerError

An object containing more specific information than the current object about the error.

Name	Type	Description
code	string	The error code.
innererror	MapsInnerError	An object containing more specific information than the current object about the error.

MultiLineStringGeometry

Specifies the GeoJSON MultiLineString Geometry object. For more information, see RFC 7946.

Name	Type	Description
coordinates	number[]	Coordinates for the `GeoJson MultiLineString` geometry.
type	string: MultiLineString	Specifies the geometry type for the 'GeoJSON` Geometry object. For more information, see RFC 7946.

OptimizeRoute

Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information.

Example: "optimizeRoute":"shortest"

Name	Type	Description
fastestAvoidClosureWithoutTraffic	string	The route is calculated to minimize the time and avoid road closures. No traffic information except for road closures is used in the calculation. `Note`: Only supported for driving travelMode.
fastestWithTraffic	string	The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode.
fastestWithoutTraffic	string	Finds the fastest route, without factoring in traffic information.
shortest	string	The route is calculated to minimize the distance. Traffic information is not used.

Order

Sequence for visiting waypoints and viaWaypoints.

Name	Type	Description
inputIndex	integer	User-provided index for waypoint and viaWaypoint inputs.
optimizedIndex	integer	System-optimized waypoint and viaWaypoint index.

PointGeometry

Specifies the GeoJSON Point Geometry object. For more information, see RFC 7946.

Name	Type	Description
coordinates	number[]	A `Position` is an array of numbers with two or more elements. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type	string: Point	Specifies the geometry type for the 'GeoJSON` Geometry object. For more information, see RFC 7946.

RegionTravelSummary

Travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).

Name	Type	Description
adminDistricts	AdminDistrict[]	adminDistrict array.
countryRegion	string	Country region name.
distanceInMeters	number	Length In Meters property
durationInSeconds	integer	Estimated travel time in seconds that does not include delays on the route due to traffic conditions.
durationTrafficInSeconds	integer	The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.

RoadTypeEnum

The type of road. Note: Only supported for driving travelMode.

Name	Type	Description
Arterial	string	Arterial.
Ferry	string	Ferry.
Highway	string	Highway.
LimitedAccessHighway	string	LimitedAccessHighway.
MajorRoad	string	MajorRoad.
NotApplicable	string	NotApplicable.
Ramp	string	Ramp.
Street	string	Street.
WalkingPath	string	WalkingPath.

RouteOutputOption

Include the desired route information from the response. By default, the itinerary is included in the response.

Supports multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"]

Name	Type	Description
itinerary	string	Include detailed directions in the response. Detailed directions are provided as "ManeuverPoints" and contain details such as turn-by-turn instructions.
regionTravelSummary	string	Include travel summary of distance, time, and toll road distance by two entity types: country (e.g., US, Canada) and administrative division or subregion (e.g., "state" in US and "province" in Canada). `Note`: Only supported for driving and walking travelMode
routePath	string	Include a GeoJSON MultiLineString RFC 7946, section 3.1.5 that describe the route's path in the response.
routeSummary	string	Include only travel time and distance for the route, and do not provide other information.

RoutePathPoint

Refers to the index of a point within a specific Leg of a route.

Name	Type	Description
legIndex	integer	The route Leg index is a sequential number assigned to each Leg of the route to help identify and distinguish between different segments of the route.
pointIndex	integer	Index of a point within a specific Leg.

RoutePathProperties

Specifies the properties that describe the route's path in the response.

Name	Type	Description
arrivalTime		The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by RFC 3339, section 5.6. It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.
departureTime		The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by RFC 3339, section 5.6. It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.
distanceInMeters	number	The physical distance in meters covered by the entire route.
durationInSeconds	integer	Estimated travel time in seconds that does not include delays on the route due to traffic conditions.
durationTrafficInSeconds	integer	The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.
legs	Leg[]	An array of route Legs. Check route Leg object description for more information.
resourceId	string	A unique ID for the resource.
trafficCongestion	TrafficCongestionEnum	The level of traffic congestion along the route. `Note`: Only supported for driving travelMode
trafficDataUsed	TrafficDataUsedEnum	The type of real-time traffic data used to generate the route.
type	string: RoutePath	Output type.

RoutePathRange

Refers to the range covered by a specific Leg of a route or path.

Name	Type	Description
legIndex	integer	The route Leg index is a sequential number assigned to each Leg of the route to help identify and distinguish between different segments of the route.
range	integer[]	Refers to the range covered by a specific Leg of a route or path.

RouteTravelMode

The mode of travel for the route path in the response.

Name	Type	Description
driving	string	Routes optimized for cars.
other	string	RouteTravelMode is returned as "other" for the truck travelMode when the truck route is not available for a particular section of a route.
truck	string	Routes optimized for large size trucks based on the vehicle specification.
walking	string	Routes optimized for pedestrians.

SideOfStreetEnum

The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.

Name	Type	Description
Left	string	Left.
Right	string	Right.
Unknown	string	Unknown.

Step

A route Leg contain turn-by-turn instructions. A step refers to a range of a route between two consecutive maneuverPoint.

Name	Type	Description
compassDegrees	number	The direction in degrees. `Note`: Only supported for driving travelMode.
maneuverType	ManeuverTypeEnum	The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.
names	string[]	A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.
roadType	RoadTypeEnum	The type of road. `Note`: Only supported for driving travelMode.
routePathRange	RoutePathRange	Refers to the range covered by a specific Leg of a route or path.

SubLeg

Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.

Name	Type	Description
distanceInMeters	number	The physical distance in meters covered by the sub-leg.
durationInSeconds	integer	Estimated travel time in seconds that does not include delays on the route due to traffic conditions.
durationTrafficInSeconds	integer	The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.
routePathRange	RoutePathRange	Refers to the range covered by a specific Leg of a route or path.

Summary

Summary for the batch request

Name	Type	Description
successfulRequests	integer	Number of successful requests in the batch
totalRequests	integer	Total number of requests in the batch

TrafficCongestionEnum

The level of traffic congestion along the route. Note: Only supported for driving travelMode

Name	Type	Description
Heavy	string	Heavy.
Medium	string	Medium.
Mild	string	Mild.
None	string	None.
Unknown	string	Unknown.

TrafficDataUsedEnum

The type of real-time traffic data used to generate the route.

Name	Type	Description
Closure	string	Real-time closure data used, if applicable.
Flow	string	Real-time traffic speeds used to calculate travel time.
FlowAndClosure	string	Flow and Closure.
None	string	None.

TravelMode

The mode of travel for the requested route. If not defined, the default value is "driving" that returns the route optimized for cars.

Note: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be "other".

Example: "travelMode":"driving"

Name	Type	Description
driving	string	The returned routes are optimized for cars.
truck	string	The returned routes are optimized for large size trucks based on the vehicle specification.
walking	string	The returned routes are optimized for pedestrians, including the use of sidewalks.

VehicleLoadType

Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request.

Name	Type	Description
USHazmatClass1	string	Explosives
USHazmatClass2	string	Compressed gas
USHazmatClass3	string	Flammable liquids
USHazmatClass4	string	Flammable solids
USHazmatClass5	string	Oxidizers
USHazmatClass6	string	Poisons
USHazmatClass7	string	Radioactive
USHazmatClass8	string	Corrosives
USHazmatClass9	string	Miscellaneous
otherHazmatExplosive	string	Explosives
otherHazmatGeneral	string	Miscellaneous
otherHazmatHarmfulToWater	string	Harmful to water

VehicleSpec

Vehicle attributes are specified inside of a vehicleSpec. Different regions may have different definitions for the truck classification and types, e.g., light truck, medium truck, heavy truck, etc. To get the most accurate results of the route restrictions based on the truck specs, specify the vehicle attributes.

Note: Only supported for truck travelMode.

Name	Type	Default value	Description
axleCount	integer	0	Number of axles on the vehicle. A value of 0 means that axle restrictions are not considered.
axleWeight	integer	0	Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.
height	number	0	Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.
isVehicleCommercial	boolean	False	Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads.
length	number	0	Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.
loadType	VehicleLoadType[]		Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request.
maxSpeed	integer	0	Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
weight	integer	0	Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered.
width	number	0	Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.

ViaWaypointProperties

Specifies the properties of a ViaWaypoint which is a waypoint that must be passed through or visited along a route or trip.

Name	Type	Description
names	string[]	A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.
order	Order	Sequence for visiting waypoints and viaWaypoints.
routePathPoint	RoutePathPoint	Refers to the index of a point within a specific Leg of a route.
type	string: ViaWaypoint	Output type.

WaypointProperties

Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.

Name	Type	Default value	Description
compassDirection	string		The direction of travel associated with a maneuver on a route, such as south or southwest. `Note`: Only supported for driving travelMode.
distanceInMeters	number		The physical distance in meters covered by this route step.
durationInSeconds	integer		The time that it takes, in seconds, to travel a corresponding `TravelDistance`.
exitIdentifier	string		The name or number of the exit associated with this route step.
instruction	Instruction		A description of a maneuver in a set of directions.
order	Order		Sequence for visiting waypoints and viaWaypoints.
routePathPoint	RoutePathPoint		Refers to the index of a point within a specific Leg of a route.
sideOfStreet	SideOfStreetEnum		The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.
signs	string[]		Signage text for the route. There may be more than one sign value.
steps	Step[]		Steps between two consecutive maneuver points.
towardsRoadName	string		The name of the street that the route goes towards in the first `ManeuverPoint`.
travelMode	RouteTravelMode	driving	The mode of travel for the route path in the response.
type	string: Waypoint		Output type.

Share via

Route - Post Directions Batch

Submit Synchronous Batch Request

POST Body for Batch Request

Batch Response Model

URI Parameters

Request Header

Request Body

Responses

Security

AADToken

Scopes

subscription-key

SAS Token

Examples

A Route Directions Batch request containing 2 queries

Sample request

Sample response

Definitions

AdminDistrict

Avoid

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizeRoute

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteOutputOption

RoutePathPoint

RoutePathProperties

RoutePathRange

RouteTravelMode

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelMode

VehicleLoadType

VehicleSpec

ViaWaypointProperties

WaypointProperties

Additional resources