Microsoft Azure
Microsoft Azure Route API

The Route API from Microsoft Azure — 4 operation(s) for route.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Route API
schemes:
- https
tags:
- name: Route
paths:
  /route/matrix/{format}:
    post:
      x-publish: true
      description: '<br><br>**Applies to**: S1 pricing tier.<br><br>The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let''s say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.<br><br><br>For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.<br><br><br>The maximum size of a matrix for async request is **700** and for sync request it''s **100** (the number of origins multiplied by the number of destinations).<br><br><br><br>### Submit Synchronous Route Matrix Request<br>If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).<br><br>```<br>POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}<br>```<br><br>### Submit Asynchronous Route Matrix Request<br>The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.<br><br><br>The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).<br><br><br>The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.<br><br><br><br><br>```<br>POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}<br>```<br><br>Here''s a typical sequence of asynchronous operations:<br>1. Client sends a Route Matrix POST request to Azure Maps<br><br>2. The server will respond with one of the following:<br><br>    > HTTP `202 Accepted` -  Route Matrix request has been accepted.<br><br>    > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.<br><br><br>3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:<br><br>  ```<br>    GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}<br>  ```<br><br><br>4. Client issues a GET request on the download URL obtained in Step 3 to download the results<br><br>### Download Sync Results<br>When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.<br><br>### Download Async Results<br>When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:<br>```<br>  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}<br>```<br><br>The URL provided by the location header will return the following responses when a `GET` request is issued.<br><br>  > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.<br><br>  > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.'
      operationId: microsoftAzureRoutePostroutematrix
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        MatrixRoute:
          $ref: ./examples/PostMatrixRouteCalculate.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: waitForResults
        in: query
        description: Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**.
        required: false
        type: boolean
        default: false
      - $ref: '#/parameters/ComputeTravelTimeFor'
      - $ref: '#/parameters/SectionType'
      - $ref: '#/parameters/ArriveAt'
      - $ref: '#/parameters/DepartAt'
      - $ref: '#/parameters/VehicleAxleWeight'
      - $ref: '#/parameters/VehicleLength'
      - $ref: '#/parameters/VehicleHeight'
      - $ref: '#/parameters/VehicleWidth'
      - $ref: '#/parameters/VehicleMaxSpeed'
      - $ref: '#/parameters/VehicleWeightMatrix'
      - $ref: '#/parameters/Windingness'
      - $ref: '#/parameters/Hilliness'
      - $ref: '#/parameters/TravelMode'
      - $ref: '#/parameters/Avoid'
      - $ref: '#/parameters/Traffic'
      - $ref: '#/parameters/RouteType'
      - $ref: '#/parameters/VehicleLoadType'
      - name: routeMatrixBody
        description: The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API.
        in: body
        required: true
        schema:
          $ref: '#/definitions/RouteMatrixRequestBody'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RouteMatrixResponse'
        '202':
          $ref: '#/responses/202Async'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      produces:
      - application/json
      summary: Microsoft Azure Post Route Matrix Format
      tags:
      - Route
  /route/directions/{format}:
    get:
      x-publish: true
      description: '**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.<br><br>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.<br><br>Routing service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.'
      operationId: microsoftAzureRouteGetroutedirections
      x-ms-examples:
        GetRouteDirections:
          $ref: ./examples/GetRouteDirections.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: query
        description: The Coordinates through which the route is calculated, delimited by a colon.  A minimum of two coordinates is required.  The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route.  You can pass up to 150 WayPoints.
        required: true
        type: string
      - name: maxAlternatives
        in: query
        description: 'Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5'
        required: false
        type: integer
        minimum: 0
        maximum: 5
        default: 0
      - $ref: '#/parameters/AlternativeRouteType'
      - name: minDeviationDistance
        in: query
        description: All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt
        required: false
        type: integer
        default: 0
      - $ref: '#/parameters/ArriveAt'
      - $ref: '#/parameters/DepartAt'
      - name: minDeviationTime
        in: query
        description: "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n  - The origin point of the _calculateRoute_ Request must be on\n    (or very near) the input reference route.\n    - If this is not the case, an error is returned.\n    - However, the origin point does not need to be at the beginning\n      of the input reference route (it can be thought of as the current\n      vehicle position on the reference route).\n  - The reference route, returned as the first route in the _calculateRoute_\n    Response, will start at the origin point specified in the _calculateRoute_\n    Request. The initial part of the input reference route up until the origin\n    point will be excluded from the Response.\n  - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n    how far alternative routes will be guaranteed to follow the reference\n    route from the origin point onwards.\n  - The route must use _departAt_.\n  - The _vehicleHeading_ is ignored."
        required: false
        type: integer
        default: 0
      - $ref: '#/parameters/RouteInstructionsType'
      - name: language
        in: query
        description: 'The language parameter determines the language of the guidance messages. Proper nouns (the names of streets, plazas, etc.) are returned in the specified  language, or if that is not available, they are returned in an available language  that is close to it. Allowed values are (a subset of) the IETF language tags. The currently supported  languages are listed in the [Supported languages  section](https://docs.microsoft.com/azure/azure-maps/supported-languages).


          Default value: en-GB'
        required: false
        type: string
      - $ref: '#/parameters/ComputeBestOrder'
      - $ref: '#/parameters/RouteRepresentation'
      - $ref: '#/parameters/ComputeTravelTimeFor'
      - $ref: '#/parameters/VehicleHeading'
      - $ref: '#/parameters/Report'
      - $ref: '#/parameters/SectionType'
      - $ref: '#/parameters/VehicleAxleWeight'
      - $ref: '#/parameters/VehicleWidth'
      - $ref: '#/parameters/VehicleHeight'
      - $ref: '#/parameters/VehicleLength'
      - $ref: '#/parameters/VehicleMaxSpeed'
      - $ref: '#/parameters/VehicleWeight'
      - $ref: '#/parameters/VehicleCommercial'
      - $ref: '#/parameters/Windingness'
      - $ref: '#/parameters/Hilliness'
      - $ref: '#/parameters/TravelMode'
      - $ref: '#/parameters/Avoid'
      - $ref: '#/parameters/Traffic'
      - $ref: '#/parameters/RouteType'
      - $ref: '#/parameters/VehicleLoadType'
      - $ref: '#/parameters/VehicleEngineType'
      - $ref: '#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm'
      - $ref: '#/parameters/CurrentFuelInLiters'
      - $ref: '#/parameters/AuxiliaryPowerInLitersPerHour'
      - $ref: '#/parameters/FuelEnergyDensityInMJoulesPerLiter'
      - $ref: '#/parameters/AccelerationEfficiency'
      - $ref: '#/parameters/DecelerationEfficiency'
      - $ref: '#/parameters/UphillEfficiency'
      - $ref: '#/parameters/DownhillEfficiency'
      - $ref: '#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm'
      - $ref: '#/parameters/CurrentChargeInkWh'
      - $ref: '#/parameters/MaxChargeInkWh'
      - $ref: '#/parameters/AuxiliaryPowerInkW'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RouteDirectionsResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Route Directions Format
      tags:
      - Route
    post:
      x-publish: true
      description: '**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.<br><br>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.<br><br>Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.'
      operationId: microsoftAzureRoutePostroutedirections
      x-ms-examples:
        PostRouteDirections:
          $ref: ./examples/PostRouteDirections.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: query
        description: The Coordinates through which the route is calculated. Needs two coordinates at least. Delimited by colon. First one is the origin and the last is the destination of the route. The coordinates are in a  lat,long format. Optional coordinates in between act as WayPoints in the route.
        required: true
        type: string
      - name: maxAlternatives
        in: query
        description: 'Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5'
        required: false
        type: integer
        minimum: 0
        maximum: 5
        default: 0
      - $ref: '#/parameters/AlternativeRouteType'
      - name: minDeviationDistance
        in: query
        description: All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt
        required: false
        type: integer
        default: 0
      - name: minDeviationTime
        in: query
        description: "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n  - The origin point of the _calculateRoute_ Request must be on\n    (or very near) the input reference route.\n    - If this is not the case, an error is returned.\n    - However, the origin point does not need to be at the beginning\n      of the input reference route (it can be thought of as the current\n      vehicle position on the reference route).\n  - The reference route, returned as the first route in the _calculateRoute_\n    Response, will start at the origin point specified in the _calculateRoute_\n    Request. The initial part of the input reference route up until the origin\n    point will be excluded from the Response.\n  - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n    how far alternative routes will be guaranteed to follow the reference\n    route from the origin point onwards.\n  - The route must use _departAt_.\n  - The _vehicleHeading_ is ignored."
        required: false
        type: integer
        default: 0
      - $ref: '#/parameters/RouteInstructionsType'
      - name: language
        in: query
        description: The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described
        required: false
        type: string
      - $ref: '#/parameters/ComputeBestOrder'
      - $ref: '#/parameters/RouteRepresentation'
      - $ref: '#/parameters/ComputeTravelTimeFor'
      - $ref: '#/parameters/VehicleHeading'
      - $ref: '#/parameters/Report'
      - $ref: '#/parameters/SectionType'
      - $ref: '#/parameters/ArriveAt'
      - $ref: '#/parameters/DepartAt'
      - $ref: '#/parameters/VehicleAxleWeight'
      - $ref: '#/parameters/VehicleLength'
      - $ref: '#/parameters/VehicleHeight'
      - $ref: '#/parameters/VehicleWidth'
      - $ref: '#/parameters/VehicleMaxSpeed'
      - $ref: '#/parameters/VehicleWeight'
      - $ref: '#/parameters/VehicleCommercial'
      - $ref: '#/parameters/Windingness'
      - $ref: '#/parameters/Hilliness'
      - $ref: '#/parameters/TravelMode'
      - $ref: '#/parameters/Avoid'
      - $ref: '#/parameters/Traffic'
      - $ref: '#/parameters/RouteType'
      - $ref: '#/parameters/VehicleLoadType'
      - $ref: '#/parameters/VehicleEngineType'
      - $ref: '#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm'
      - $ref: '#/parameters/CurrentFuelInLiters'
      - $ref: '#/parameters/AuxiliaryPowerInLitersPerHour'
      - $ref: '#/parameters/FuelEnergyDensityInMJoulesPerLiter'
      - $ref: '#/parameters/AccelerationEfficiency'
      - $ref: '#/parameters/DecelerationEfficiency'
      - $ref: '#/parameters/UphillEfficiency'
      - $ref: '#/parameters/DownhillEfficiency'
      - $ref: '#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm'
      - $ref: '#/parameters/CurrentChargeInkWh'
      - $ref: '#/parameters/MaxChargeInkWh'
      - $ref: '#/parameters/AuxiliaryPowerInkW'
      - name: routeDirectionsRequestBody
        description: 'Used for reconstructing a route and for calculating zero or more alternative routes to this reference route.  The provided sequence of coordinates is used as input for route reconstruction. The alternative routes  are calculated between the origin and destination points specified in the base path parameter locations.  If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points  are expected to be at (or very near) the beginning and end of the reference route, respectively. Intermediate  locations (waypoints) are not supported when using supportingPoints.


          Setting at least one of minDeviationDistance or minDeviationTime to a value greater than zero has the  following consequences:


          *  The origin point of the calculateRoute request must be on (or very near) the input reference route. If  this is not the case, an error is returned. However, the origin point does not need to be at the beginning of  the input reference route (it can be thought of as the current vehicle position on the reference route).

          *  The reference route, returned as the first route in the calculateRoute response, will start at the origin  point specified in the calculateRoute request. The initial part of the input reference route up until the  origin point will be excluded from the response.

          *  The values of minDeviationDistance and minDeviationTime determine how far alternative routes will be  guaranteed to follow the reference route from the origin point onwards.

          *  The route must use departAt.

          *  The vehicleHeading is ignored.'
        in: body
        required: true
        schema:
          $ref: '#/definitions/RouteDirectionsRequestBody'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RouteDirectionsResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Post Route Directions Format
      tags:
      - Route
  /route/range/{format}:
    get:
      x-publish: true
      description: '__Route Range (Isochrone) API__<br><br><br>**Applies to**: S1 pricing tier.<br><br>This service will calculate a set of locations that can be reached from the origin point based on fuel, energy,  time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise  orientation as well as the precise polygon center which was the result of the origin point.<br><br>The returned polygon can be used for further processing such as  [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to  search for POIs within the provided Isochrone.'
      operationId: microsoftAzureRouteGetrouterange
      x-ms-examples:
        GetRouteRange:
          $ref: ./examples/GetRouteRange.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: query
        description: The Coordinate from which the range calculation should start.
        required: true
        type: string
      - name: fuelBudgetInLiters
        in: query
        description: Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.<br> When fuelBudgetInLiters is used, it is mandatory to specify a detailed  Combustion Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.
        required: false
        type: number
        format: float
      - name: energyBudgetInkWh
        in: query
        description: Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model.<br> When energyBudgetInkWh is used, it is mandatory to specify a detailed Electric Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.
        required: false
        type: number
        format: float
      - name: timeBudgetInSec
        in: query
        description: Time budget in seconds that determines maximal range which can be travelled using driving time. The Consumption Model will only affect the range when routeType is eco.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.
        required: false
        type: number
        format: float
      - name: distanceBudgetInMeters
        in: query
        description: Distance budget in meters that determines maximal range which can be travelled using driving distance.  The Consumption Model will only affect the range when routeType is eco.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.
        required: false
        type: number
        format: float
      - $ref: '#/parameters/DepartAt'
      - $ref: '#/parameters/RouteType'
      - $ref: '#/parameters/Traffic'
      - $ref: '#/parameters/Avoid'
      - $ref: '#/parameters/TravelMode'
      - $ref: '#/parameters/Hilliness'
      - $ref: '#/parameters/Windingness'
      - $ref: '#/parameters/VehicleAxleWeight'
      - $ref: '#/parameters/VehicleWidth'
      - $ref: '#/parameters/VehicleHeight'
      - $ref: '#/parameters/VehicleLength'
      - $ref: '#/parameters/VehicleMaxSpeed'
      - $ref: '#/parameters/VehicleWeight'
      - $ref: '#/parameters/VehicleCommercial'
      - $ref: '#/parameters/VehicleLoadType'
      - $ref: '#/parameters/VehicleEngineType'
      - $ref: '#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm'
      - $ref: '#/parameters/CurrentFuelInLiters'
      - $ref: '#/parameters/AuxiliaryPowerInLitersPerHour'
      - $ref: '#/parameters/FuelEnergyDensityInMJoulesPerLiter'
      - $ref: '#/parameters/AccelerationEfficiency'
      - $ref: '#/parameters/DecelerationEfficiency'
      - $ref: '#/parameters/UphillEfficiency'
      - $ref: '#/parameters/DownhillEfficiency'
      - $ref: '#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm'
      - $ref: '#/parameters/CurrentChargeInkWh'
      - $ref: '#/parameters/MaxChargeInkWh'
      - $ref: '#/parameters/AuxiliaryPowerInkW'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RouteRangeResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Route Range Format
      tags:
      - Route
  /route/directions/batch/{format}:
    post:
      x-publish: true
      description: '**Route Directions Batch API**<br><br><br>**Applies to**: S1 pricing tier.<br><br><br><br>The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.<br>### Submit Synchronous Batch Request<br>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.<br>```<br>POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}<br>```<br>### Submit Asynchronous Batch Request<br>The Asynchronous API is appropriate for processing big volumes of relatively complex route requests<br>- It allows the retrieval of results in a separate call (multiple downloads are possible).<br>- The asynchronous API is optimized for reliability and is not expected to run into a timeout.<br>- The number of batch items is limited to **700** for this API.<br><br>When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.<br>The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.<br><br>Please note that asynchronous batch request is a long-running operation. Here''s a typical sequence of operations:<br>1. Client sends a Route Directions Batch `POST` request to Azure Maps<br>2. The server will respond with one of the following:<br><br>    > HTTP `202 Accepted` - Batch request has been accepted.<br><br>    > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.<br><br>3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.<br>    This status URI looks like following:<br><br>``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```<br>Note:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it. <br>4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.<br><br>### POST Body for Batch Request<br>To send the _route 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 3 _route directions_ queries:<br><br><br>```json<br>{<br>    "batchItems": [<br>        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },<br>        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },<br>        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }<br>    ]<br>}<br>```<br><br>A _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded.<br><br><br>The async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.<br><br><br>### Download Asynchronous Batch Results<br>To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:<br><br>```<br>https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}<br>```<br>Here''s the typical sequence of operations for downloading the batch results:<br>1. Client sends a `GET` request using the _download URL_.<br>2. The server will respond with one of the following:<br>    <br>    > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.<br><br>    > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.<br><br><br><br>### Batch Response Model<br>The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch respo

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-route-api-openapi.yml
Microsoft Azure Route API

Documentation

Specifications

Other Resources

OpenAPI Specification
