Azure Maps Route Service (preview:2023-08-01)

2025/10/15 • 2 deleted methods

Route_PostDirections (removed)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
Reference :  Link ¶

⚼ Request

POST:  /route/directions
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/supported-culture-codes) for details. ,
Required: False ,
}
string ,
routeDirectionsRequest:
{
Description: Request body of RouteDirections API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: must be FeatureCollection ,
Enum:
{
FeatureCollection: No description available. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. The start and end points of the route cannot be viaWaypoints. ,
Required: True ,
}
[
{
type:
{
Description: must be Feature ,
Enum:
{
Feature: No description available. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Waypoint properties ,
Required: True ,
}
{
pointIndex:
{
Description: It is used to identify and order the sequence of waypoints in the route.The default value is the `index value` of a features array. ,
Format: int64 ,
Required: False ,
}
integer ,
pointType:
{
Description: waypoint type ,
Enum:
{
waypoint: A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point. ,
viaWaypoint: A viaWaypoint is specific waypoint that must be passed through or visited along a route or trip. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
travelMode:
{
Description: The mode of travel for the requested route. ,
Enum:
{
driving: The returned routes are optimized for common driving scenarios. ,
truck: The returned routes are optimized for trucks. ,
walking: The returned routes are optimized for pedestrians, including the use of sidewalks. ,
}
,
Required: False ,
}
enum ,
departAt:
{
Description: The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format defined by (RFC 3339, section 5.6)[https://www.rfc-editor.org/rfc/rfc3339#section-5.6]. For example, `2022-06-01T09:30:00.000-07:00` ,
Format: date-time ,
Required: False ,
}
string ,
arriveAt:
{
Description: The date and time of arrival at the destination point. It must be specified as a dateTime format defined by (RFC 3339, section 5.6)[https://www.rfc-editor.org/rfc/rfc3339#section-5.6]. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt. ,
Format: date-time ,
Required: False ,
}
string ,
optimizeRoute:
{
Description: Specifies what parameters to use to optimize the route. ,
Enum:
{
shortest: The route is calculated to minimize the distance. Traffic information is not used. ,
fastestWithoutTraffic: The route is calculated to minimize the time. Traffic information is not used. ,
fastestAvoidClosureWithoutTraffic: The route is calculated to minimize the time and avoid road closures. Traffic information except road closures are not used in the calculation. ,
fastestWithTraffic: The route is calculated to minimize the time and uses current traffic information. ,
}
,
Required: False ,
}
enum ,
optimizeWaypointOrder:
{
Description: Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Notice that origin and destination are excluded from the optimized waypoint indices.Possible values are true or false. `Note`:This parameter is only available for the driving and Truck mode. ,
Required: False ,
}
boolean ,
avoid:
{
Description: Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple items, for example, '"avoid": ["highways", "tollRoads"]'. Noted that tunnels are not supported for driving and walking mode. ,
Required: False ,
}
[
string ,
]
,
routeOutputOptions:
{
Description: Information of route being returned. Can specify multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"]. ,
Required: False ,
}
[
string ,
]
,
maxRouteCount:
{
Description: Number of maximal routes to be calculated. Default: 1, minimum: 1 and maximum: 3 ,
Format: int64 ,
Required: False ,
}
integer ,
vehicleSpec:
{
Required: False ,
}
{
isVehicleCommercial:
{
Description: Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. `Note`: The parameter is available only for truck mode ,
Required: False ,
}
boolean ,
heading:
{
Description: The 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 ,
Format: int64 ,
Required: False ,
}
integer ,
length:
{
Description: Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. `Note`: The parameter is available only for truck mode. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. `Note`: The parameter is available only for truck mode. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. `Note`: The parameter is available only for truck mode. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Weight of the vehicle in kilograms. `Note`: The parameter is available only for truck mode. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSpeed:
{
Description: 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. `Note`: The parameter is available only for truck mode. ,
Format: int64 ,
Required: False ,
}
integer ,
axleCount:
{
Description: Number of axles of the vehicle. `Note`: The parameter is available only for truck mode. ,
Format: int64 ,
Required: False ,
}
integer ,
axleWeight:
{
Description: Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.`Note`: The parameter is available only for truck mode. ,
Format: int64 ,
Required: False ,
}
integer ,
loadType:
{
Description: 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 can be specified multiple times. `Note`: The parameter is available only for truck mode. ,
Enum:
{
USHazmatClass1: Explosives ,
USHazmatClass2: Compressed gas ,
USHazmatClass3: Flammable liquids ,
USHazmatClass4: Flammable solids ,
USHazmatClass5: Oxidizers ,
USHazmatClass6: Poisons ,
USHazmatClass7: Radioactive ,
USHazmatClass8: Corrosives ,
USHazmatClass9: Miscellaneous ,
otherHazmatExplosive: Explosives ,
otherHazmatGeneral: Miscellaneous ,
otherHazmatHarmfulToWater: Harmful to water ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: This object is returned from a successful call ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostDirectionsBatch (removed)
Description :  **Directions Batch API** **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Directions Batch API sends batches of queries to Directions API using just a single API call. The API allows caller to batch up to **100** queries. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/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-08-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": [ "routeSummariesOnly" ], "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_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/directions#uri-parameters) except query. 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`](https://docs.microsoft.com/en-us/rest/api/maps/route/directions#directionsresponse) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
Reference :  Link ¶

⚼ Request

POST:  /route/directions:batch
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
routeDirectionsBatchRequest:
{
Description: The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (207)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}