Sign in

The Route Range Batch API sends batches of up to **100** queries as a single call to the [Route Range API](/rest/api/maps/route/post-route-range?view=rest-maps-2024-07-01-preview).

[!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/range:batch?api-version=2024-07-01-preview

POST Body for Batch Request

To send the route range 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 route_range queries:

{
  "batchItems": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "timeBudgetInSec": 2000
      }
    }
  ]
}

A route range batchItem object can accept any of the supported snap to roads 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:

  • RouteRangeResponse - If the query completed successfully.

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

post/route/range:batch

Query parameters

api-versionstring required

Version number of Azure Maps API.

Parameters

../../../Common/preview/1.0/common.json#/components/parameters/ClientId — unresolved $ref

Request body

batchItemsRouteRangeBatchRequestItem[] — unresolved $ref

The list of queries to process.

Response

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

Changes