Updated api_version to 2025-01-01 for example requests to the Route service.

stevemunk · stevemunk · commit 5791f029c627 · 2025-02-19T10:52:40.000-08:00
diff --git a/articles/azure-maps/azure-maps-authentication.md b/articles/azure-maps/azure-maps-authentication.md
@@ -74,7 +74,7 @@ After the application receives an access token, the SDK and/or application sends
 Here's an example of an Azure Maps route request that uses a Microsoft Entra ID OAuth Bearer token:
 
 ```http
-GET /route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872
+GET /route/directions/json?api-version=2025-01-01&query=52.50931,13.42936:52.50274,13.43872
 Host: atlas.microsoft.com
 x-ms-client-id: 30d7cc….9f55
 Authorization: Bearer eyJ0e…HNIVN
diff --git a/articles/azure-maps/how-to-use-best-practices-for-routing.md b/articles/azure-maps/how-to-use-best-practices-for-routing.md
@@ -81,7 +81,7 @@ The next sections demonstrate how to make calls to the Route APIs using the disc
 In the first example below the departure time is set to the future, at the time of writing.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&query=51.368752,-0.118332:51.385426,-0.128929&travelMode=car&traffic=true&departAt=2025-03-29T08:00:20&computeTravelTimeFor=all
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&query=51.368752,-0.118332:51.385426,-0.128929&travelMode=car&traffic=true&departAt=2025-03-29T08:00:20&computeTravelTimeFor=all
 ```
 
 The response contains a summary element, like the following example. Because the departure time is set to the future, the **trafficDelayInSeconds** value is zero. The **travelTimeInSeconds** value is calculated using time-dependent historic traffic data. So, in this case, the **travelTimeInSeconds** value is equal to the **historicTrafficTravelTimeInSeconds** value.
@@ -104,7 +104,7 @@ The response contains a summary element, like the following example. Because the
 In the next example, we have a real-time routing request, where departure time is now. It's not explicitly specified in the URL because it's the default value.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&query=47.6422356,-122.1389797:47.6641142,-122.3011268&travelMode=car&traffic=true&computeTravelTimeFor=all
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&query=47.6422356,-122.1389797:47.6641142,-122.3011268&travelMode=car&traffic=true&computeTravelTimeFor=all
 ```
 
 The response contains a summary as shown in the following example. Because of congestion, the **trafficDelaysInSeconds** value is greater than zero. It's also greater than **historicTrafficTravelTimeInSeconds**.
@@ -155,7 +155,7 @@ Azure Maps Routing APIs support commercial vehicle routing, covering commercial
 The sample request below queries a route for a commercial truck. The truck is carrying class 1 hazardous waste material.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&vehicleWidth=2&vehicleHeight=2&vehicleCommercial=true&vehicleLoadType=USHazmatClass1&travelMode=truck&instructionsType=text&query=51.368752,-0.118332:41.385426,-0.128929
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&vehicleWidth=2&vehicleHeight=2&vehicleCommercial=true&vehicleLoadType=USHazmatClass1&travelMode=truck&instructionsType=text&query=51.368752,-0.118332:41.385426,-0.128929
 ```
 
 The Route API returns directions that accommodate the dimensions of the truck and the hazardous waste. You can read the route instructions by expanding the `guidance` element.
@@ -167,7 +167,7 @@ The Route API returns directions that accommodate the dimensions of the truck an
 Changing the US Hazmat Class, from the above query, results in a different route to accommodate this change.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&vehicleWidth=2&vehicleHeight=2&vehicleCommercial=true&vehicleLoadType=USHazmatClass9&travelMode=truck&instructionsType=text&query=51.368752,-0.118332:41.385426,-0.128929
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&vehicleWidth=2&vehicleHeight=2&vehicleCommercial=true&vehicleLoadType=USHazmatClass9&travelMode=truck&instructionsType=text&query=51.368752,-0.118332:41.385426,-0.128929
 ```
 
 The following response is for a truck carrying a class 9 hazardous material, which is less dangerous than a class 1 hazardous material. When you expand the `guidance` element to read the directions, notice that the directions aren't the same. There are more route instructions for the truck carrying class 1 hazardous material.
@@ -183,7 +183,7 @@ With the Azure Maps Route Direction APIs, developers can request details for eac
 The following query sets the `sectionType` to `traffic`. It requests the sections that contain traffic information from Seattle to San Diego.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&sectionType=traffic&query=47.6062,-122.3321:32.7157,-117.1611
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&sectionType=traffic&query=47.6062,-122.3321:32.7157,-117.1611
 ```
 
 The response contains the sections that are suitable for traffic along the given coordinates.
@@ -211,7 +211,7 @@ If you want to optimize the best order to visit the given waypoints, then you ne
 The following query requests the path for six waypoints, with the `computeBestOrder` parameter set to `false`. It's also the default value for the `computeBestOrder` parameter.
 
 ```http
-https://atlas.microsoft.com/route/directions/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&computeBestOrder=false&query=47.606544,-122.336502:47.759892,-122.204821:47.670682,-122.120415:47.480133,-122.213369:47.615556,-122.193689:47.676508,-122.206054:47.495472,-122.360861
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&computeBestOrder=false&query=47.606544,-122.336502:47.759892,-122.204821:47.670682,-122.120415:47.480133,-122.213369:47.615556,-122.193689:47.676508,-122.206054:47.495472,-122.360861
 ```
 
 The response describes the path length to be 140,851 meters, and that it would take 9,991 seconds to travel that path.
@@ -229,7 +229,7 @@ This route waypoint order is: 0, 1, 2, 3, 4, 5, and 6.
 The following query requests the path for the same six waypoints, as in the above sample. This time, the `computeBestOrder` parameter set to `true` (the traveling salesman optimization).
 
 ```http
-https://atlas.microsoft.com/route/directions/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&computeBestOrder=true&query=47.606544,-122.336502:47.759892,-122.204821:47.670682,-122.120415:47.480133,-122.213369:47.615556,-122.193689:47.676508,-122.206054:47.495472,-122.360861
+https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key}&computeBestOrder=true&query=47.606544,-122.336502:47.759892,-122.204821:47.670682,-122.120415:47.480133,-122.213369:47.615556,-122.193689:47.676508,-122.206054:47.495472,-122.360861
 ```
 
 The response describes the path length to be 91,814 meters, and that it would take 7,797 seconds to travel that path. The travel distance and the travel time are both lower here because the API returned the optimized route.
diff --git a/articles/azure-maps/itinerary-optimization-service.md b/articles/azure-maps/itinerary-optimization-service.md
@@ -78,7 +78,7 @@ Matrix size = 5 origins x 5 destinations = 25
 The Route Matrix POST request:
 
 ```html
-https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest
+https://atlas.microsoft.com/route/matrix/json?api-version=2025-01-01&routeType=shortest
 ```
 
 ```json
diff --git a/articles/azure-maps/map-route.md b/articles/azure-maps/map-route.md
@@ -256,7 +256,7 @@ const onload = () => {
 
     // Send a request to the route API
     let url = "https://atlas.microsoft.com/route/directions/json?";
-    url += "&api-version=1.0";
+    url += "&api-version=2025-01-01";
     url +=
       "&query=" +
       startPoint.geometry.coordinates[1] +
diff --git a/articles/azure-maps/migrate-calculate-route.md b/articles/azure-maps/migrate-calculate-route.md
@@ -69,7 +69,7 @@ http://dev.virtualearth.net/REST/V1/Routes/driving?wp.0=47.610173,-122.204171&wp
 Azure Maps _Route Directions_ API POST request:
 
 ``` http
-https://atlas.microsoft.com/route/directions?api-version=2023-10-01-preview&subscription-key={Your-Azure-Maps-Subscription-key} 
+https://atlas.microsoft.com/route/directions?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key} 
 ```
 
 Included in the body of the request:
diff --git a/articles/azure-maps/migrate-calculate-truck-route.md b/articles/azure-maps/migrate-calculate-truck-route.md
@@ -94,7 +94,7 @@ Included in the body of the request:
 Azure Maps _Route Directions_ API POST request:
 
 ``` http
-https://atlas.microsoft.com/route/directions?api-version=2023-10-01-preview&subscription-key={Your-Azure-Maps-Subscription-key} 
+https://atlas.microsoft.com/route/directions?api-version=2025-01-01&subscription-key={Your-Azure-Maps-Subscription-key} 
 ```
 
 Included in the body of the request:
diff --git a/articles/azure-maps/migrate-help-using-copilot.md b/articles/azure-maps/migrate-help-using-copilot.md
@@ -208,7 +208,7 @@ Step 6. Create and add a SymbolLayer to the map.
 
 Step 7. Create and add a LineLayer to the map.
 
-Step 8. Utilize the Route POST API: <https://atlas.microsoft.com/route/directions?api-version=2023-10-01-preview&subscription-key=${subscriptionKey}> to find the route between the start and end points. Add the GeoJSON response to the DataSource and adjust the map's camera based on the bounding box of the response.
+Step 8. Utilize the Route POST API: <https://atlas.microsoft.com/route/directions?api-version=2025-01-01&subscription-key=${subscriptionKey}> to find the route between the start and end points. Add the GeoJSON response to the DataSource and adjust the map's camera based on the bounding box of the response.
 
 Example request body:
 
@@ -335,7 +335,7 @@ GitHub Copilot can create the following code snippet to provide an interface for
  
       function getRoute(startCoordinates, endCoordinates) {
         fetch(
-          `https://atlas.microsoft.com/route/directions?api-version=2023-10-01-preview&subscription-key=${subscriptionKey}`,
+          `https://atlas.microsoft.com/route/directions?api-version=2025-01-01&subscription-key=${subscriptionKey}`,
           {
             method: "POST",
             headers: {
diff --git a/articles/azure-maps/tutorial-ev-routing.md b/articles/azure-maps/tutorial-ev-routing.md
@@ -97,7 +97,7 @@ routeType="eco"
 constantSpeedConsumptionInkWhPerHundredkm="50,8.2:130,21.3"
 
 # Get boundaries for the electric vehicle's reachable range.
-routeRangeResponse = await (await session.get("https://atlas.microsoft.com/route/range/json?subscription-key={}&api-version=1.0&query={}&travelMode={}&vehicleEngineType={}&currentChargeInkWh={}&maxChargeInkWh={}&timeBudgetInSec={}&routeType={}&constantSpeedConsumptionInkWhPerHundredkm={}"
+routeRangeResponse = await (await session.get("https://atlas.microsoft.com/route/range/json?subscription-key={}&api-version=2025-01-01&query={}&travelMode={}&vehicleEngineType={}&currentChargeInkWh={}&maxChargeInkWh={}&timeBudgetInSec={}&routeType={}&constantSpeedConsumptionInkWhPerHundredkm={}"
                                               .format(subscriptionKey,str(currentLocation[0])+","+str(currentLocation[1]),travelMode, vehicleEngineType, currentChargeInkWh, maxChargeInkWh, timeBudgetInSec, routeType, constantSpeedConsumptionInkWhPerHundredkm))).json()
 
 polyBounds = routeRangeResponse["reachableRange"]["boundary"]
@@ -200,7 +200,7 @@ locationData = {
          }
 
 # Get the travel time and distance to each specified charging station.
-searchPolyRes = await (await session.post(url = "https://atlas.microsoft.com/route/matrix/json?subscription-key={}&api-version=1.0&routeType=shortest&waitForResults=true".format(subscriptionKey), json = locationData)).json()
+searchPolyRes = await (await session.post(url = "https://atlas.microsoft.com/route/matrix/json?subscription-key={}&api-version=2025-01-01&routeType=shortest&waitForResults=true".format(subscriptionKey), json = locationData)).json()
 
 distances = []
 for dist in range(len(reachableLocations)):
@@ -218,7 +218,7 @@ After locating the nearest charging station, use the [Get Route Directions] API
 
 ```python
 # Get the route from the electric vehicle's current location to the closest charging station. 
-routeResponse = await (await session.get("https://atlas.microsoft.com/route/directions/json?subscription-key={}&api-version=1.0&query={}:{}".format(subscriptionKey, str(currentLocation[0])+","+str(currentLocation[1]), closestChargeLoc))).json()
+routeResponse = await (await session.get("https://atlas.microsoft.com/route/directions/json?subscription-key={}&api-version=2025-01-01&query={}:{}".format(subscriptionKey, str(currentLocation[0])+","+str(currentLocation[1]), closestChargeLoc))).json()
 
 route = []
 for loc in range(len(routeResponse["routes"][0]["legs"][0]["points"])):
diff --git a/articles/azure-maps/tutorial-prioritized-routes.md b/articles/azure-maps/tutorial-prioritized-routes.md
@@ -231,7 +231,7 @@ This section shows you how to use the Azure Maps Route service to get directions
                 endPoint.geometry.coordinates[1] + "," +
                 endPoint.geometry.coordinates[0];
     //Make a search route request for a truck vehicle type
-    var truckRouteUrl = `https://atlas.microsoft.com/route/directions/json?api-version=1.0&travelMode=truck&vehicleWidth=2&vehicleHeight=2&vehicleLength=5&vehicleLoadType=USHazmatClass2&query=${query}`;
+    var truckRouteUrl = `https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&travelMode=truck&vehicleWidth=2&vehicleHeight=2&vehicleLength=5&vehicleLoadType=USHazmatClass2&query=${query}`;
     fetch(truckRouteUrl, {
         headers: {
             "Subscription-Key": map.authentication.getToken()
@@ -275,7 +275,7 @@ This section shows you how to use the Azure Maps Route service to get directions
 2. Next, append the following JavaScript code to create a route for a car.
 
     ```JavaScript
-    var carRouteUrl = `https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=${query}`;
+    var carRouteUrl = `https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&query=${query}`;
     fetch(carRouteUrl, {
         headers: {
             "Subscription-Key": map.authentication.getToken()
diff --git a/articles/azure-maps/tutorial-route-location.md b/articles/azure-maps/tutorial-route-location.md
@@ -205,7 +205,7 @@ This section shows you how to use the Azure Maps Route Directions API to get rou
                 startPoint.geometry.coordinates[0] + ":" +
                 endPoint.geometry.coordinates[1] + "," +
                 endPoint.geometry.coordinates[0];
-    var url = `https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=${query}`;
+    var url = `https://atlas.microsoft.com/route/directions/json?api-version=2025-01-01&query=${query}`;
 
     //Make a search route request
     fetch(url, {
diff --git a/articles/azure-maps/tutorial-snap-to-road.md b/articles/azure-maps/tutorial-snap-to-road.md
@@ -142,7 +142,7 @@ The code in this notebook cell reads raw GPS data from the data file in lakehous
     import json
     
     az_maps_subkey = ""
-    az_maps_snaproads_url = "https://atlas.microsoft.com/route/snapToRoads?api-version=2024-07-01-preview&subscription-key=" + az_maps_subkey
+    az_maps_snaproads_url = "https://atlas.microsoft.com/route/snapToRoads?api-version=2025-01-01&subscription-key=" + az_maps_subkey
     
     # Function to process snap to road for each given trip
     def process_route(df, outputFilePath):
