Routing API Updates of Sept 30th #387
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update local-insights.md
|
Learn Build status updates of commit 26b734a:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| BingMaps/rest-services/routes/local-insights-data.md | n/a (file deleted or renamed) | Details | |
| BingMaps/rest-services/toc.yml | View | Details | |
| BingMaps/rest-services/routes/calculate-a-distance-matrix.md | 💡Suggestion | View | Details |
| BingMaps/rest-services/routes/local-insights.md | 💡Suggestion | View | Details |
| BingMaps/rest-services/routes/calculate-a-truck-route.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-an-isochrone.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-routes-from-major-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/route-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-points-to-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-to-road-data.md | ✅Succeeded | View |
BingMaps/rest-services/routes/local-insights-data.md
- [Warning: file-not-redirected - See documentation]
File BingMaps/rest-services/routes/local-insights-data.md with URL /BingMaps/rest-services/routes/local-insights-data was deleted without redirection. To avoid broken links, add a redirection.
BingMaps/rest-services/toc.yml
- Line 81, Column 13: [Warning: file-not-found - See documentation]
Invalid file link: 'routes/local-insights-data.md'.
BingMaps/rest-services/routes/calculate-a-distance-matrix.md
- Line 9, Column 12: [Suggestion: ms-author-invalid - See documentation]
Invalid value for 'ms.author', 'eriklind' is not a valid Microsoft alias.
BingMaps/rest-services/routes/local-insights.md
- Line 13, Column 12: [Suggestion: ms-author-invalid - See documentation]
Invalid value for 'ms.author', 'eriklind' is not a valid Microsoft alias.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 83fa7c8:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| BingMaps/rest-services/routes/local-insights-data.md | n/a (file deleted or renamed) | Details | |
| BingMaps/rest-services/routes/local-insights.md | 💡Suggestion | View | Details |
| BingMaps/rest-services/routes/calculate-a-distance-matrix.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-a-truck-route.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-an-isochrone.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-routes-from-major-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/index.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/route-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-points-to-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-to-road-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/toc.yml | ✅Succeeded | View |
BingMaps/rest-services/routes/local-insights-data.md
- [Warning: file-not-redirected - See documentation]
File BingMaps/rest-services/routes/local-insights-data.md with URL /BingMaps/rest-services/routes/local-insights-data was deleted without redirection. To avoid broken links, add a redirection.
BingMaps/rest-services/routes/local-insights.md
- Line 13, Column 12: [Suggestion: ms-author-invalid - See documentation]
Invalid value for 'ms.author', 'eriklind' is not a valid Microsoft alias.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 48239f3:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| BingMaps/rest-services/routes/local-insights-data.md | View | Details | |
| BingMaps/rest-services/routes/calculate-a-distance-matrix.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-a-truck-route.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-an-isochrone.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-routes-from-major-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/index.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/local-insights.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/route-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-points-to-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-to-road-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/toc.yml | ✅Succeeded | View |
BingMaps/rest-services/routes/local-insights-data.md
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 5ad7ee7:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| BingMaps/rest-services/routes/local-insights-data.md | View | Details | |
| BingMaps/includes/bing-maps-local-insights-api-retirement.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-a-distance-matrix.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-a-truck-route.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-an-isochrone.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/calculate-routes-from-major-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/index.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/local-insights.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/route-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-points-to-roads.md | ✅Succeeded | View | |
| BingMaps/rest-services/routes/snap-to-road-data.md | ✅Succeeded | View | |
| BingMaps/rest-services/toc.yml | ✅Succeeded | View |
BingMaps/rest-services/routes/local-insights-data.md
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
stevemunk
reviewed
Jan 14, 2025
| @@ -1,6 +1,6 @@ | |||
| > [!NOTE] | |||
| > **Bing Maps Local Insights API retirement** | |||
| > | |||
| > The Bing Maps Local Insights API is deprecated and will be retired on 9/30/2024. To avoid service disruptions, all implementations using Bing Maps Local Insights API will need to be updated to use [Azure Maps](https://azure.microsoft.com/products/azure-maps) by 9/30/2024. | |||
| > The Bing Maps Local Insights API is deprecated and was retired on 9/30/2024. To avoid service disruptions, all implementations using Bing Maps Local Insights API will need to be updated to use [Azure Maps](https://azure.microsoft.com/products/azure-maps) by 9/30/2024. | |||
There was a problem hiding this comment.
I'd like this better if we had a specific Azure Maps API to point to here... Here is a suggestion for alternative wording:
Suggested change
| > The Bing Maps Local Insights API is deprecated and was retired on 9/30/2024. To avoid service disruptions, all implementations using Bing Maps Local Insights API will need to be updated to use [Azure Maps](https://azure.microsoft.com/products/azure-maps) by 9/30/2024. | |
| > The Bing Maps Local Insights API was retired on 9/30/2024 and is no longer supported. All implementations using Bing Maps Local Insights API can be updated to use [Azure Maps](https://azure.microsoft.com/products/azure-maps). |
stevemunk
reviewed
Jan 14, 2025
| @@ -253,10 +234,10 @@ https://dev.virtualearth.net/REST/v1/Routes/DistanceMatrixAsyncCallback?requestI | |||
| |------------|-------------| | |||
| | `origins` | **Required**. List of origins described as coordinate pairs with latitudes and longitudes. The format of each coordinate pair must use one of the following formats:<br/><br/>For GET requests: lat0,lon0;lat1,lon1;...;latM,lonM<br/><br/>**Example**: origins=37.77916,-122.42;32.71568,-117.16172<br/><br/>For POST requests:<br/><br/>[<br/> {<br/> "latitude": lat0,<br/> "longitude": lon0<br/> },<br/> {<br/> "latitude": lat1,<br/> "longitude": lon1<br/> },<br/> .<br/> .<br/> .<br/> {<br/> "latitude": latN,<br/> "longitude": lonN<br/> }<br/>]<br/><br/>**Example:**<br/><br/>"origins": [<br/> {<br/> "latitude": 37.77916,<br/> "longitude": -122.42<br/> },<br/> {<br/> "latitude": 32.71568,<br/> "longitude": -117.16172<br/> }<br/>] | | |||
| | `destinations` | **Optional**. List of destinations described as coordinate pairs with latitudes and longitudes. If not specified, an n x n matrix will be generated using the origins. The format of each coordinate pair must have the following format:<br/><br/>For GET requests: lat0,lon0;lat1,lon1;...;latM,lonM<br/><br/>**Example**: destinations=37.77916,-122.42;32.71568,-117.16172<br/><br/>For POST requests:<br/><br/>[<br/> {<br/> "latitude": lat0,<br/> "longitude": lon0<br/> },<br/> {<br/> "latitude": lat1,<br/> "longitude": lon1<br/> },<br/> .<br/> .<br/> .<br/> {<br/> "latitude": latN,<br/> "longitude": lonN<br/> }<br/>]<br/><br/>**Example:**<br/><br/>"destinations": [<br/> {<br/> "latitude": 37.77916,<br/> "longitude": -122.42<br/> },<br/> {<br/> "latitude": 32.71568,<br/> "longitude": -117.16172<br/> }<br/>] | | |||
| | `travelMode` | **Required**. Specifies the mode of transportation to use when calculating the distance matrix. Can be one of the following values:<br/><br/> • driving<br/> • walking<br/> • transit<br/><br/>**Example**: travelMode=driving <br /> <br /> **Geographic Availability**: <br /> - `Driving` is available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea. <br /> - `Walking` is available in North America (US, Canada, Mexico). <br /> - `Transit` is available in markets seen in the [Transit Coverage documentation](../../coverage/transit-coverage/index.md).| | |||
| | `travelMode` | **Required**. Specifies the mode of transportation to use when calculating the distance matrix. Can be one of the following values:<br/><br/> • driving<br/> • walking<br/> • ~~transit~~ [deprecated]<br/><br/>**Example**: travelMode=driving <br /> <br /> **Geographic Availability**: <br /> - `Driving` is available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea. <br /> - `Walking` is available in North America (US, Canada, Mexico). <br /> | | |||
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"? Why is it in square brackets?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
stevemunk
reviewed
Jan 14, 2025
| | `endTime` | **Optional for Driving**. If specified, a matrix based on traffic data with contain a histogram of travel times and distances for the specified resolution intervals (default is 15 minutes) between the start and end times. A start time must be specified for the request to be valid and the total time between start and end cannot be greater than 24 hours. This should be a date string in a format that can be parsed by [DateTimeOffset.Parse](https://msdn.microsoft.com/library/bb351654.aspx). This option is only supported when the travel mode is set to driving.<br/><br/>**Example**: endTime=2017-06-15T13:00:00-07:00 | | ||
| | `resolution` | **Optional for Driving**. The number of intervals to calculate a histogram of data for each cell where a single interval is a quarter of an hour. Can be one of the following values:<br/><br/> • **1** - 15 minutes<br/> • **2** - 30 minutes<br/> • **3** - 45 minutes<br/> • **4** - an hour<br/><br/>If start time is specified and `resolution` is not, it will default to an interval of 1 (15 minutes).<br/><br/>**Example**: resolution=2 | | ||
| | `endTime` | **Deprecated**. | | ||
| | `resolution` | **Deprecated**. | |
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| @@ -217,7 +209,7 @@ https://dev.virtualearth.net/REST/v1/Routes/TruckAsyncCallback?requestId={reques | |||
| | `waypoint.n`<br/><br/>`viaWaypoint.n` | `wp.n`<br/><br/>`vwp.n` | **Required**. A route is defined by a set of waypoints and viaWaypoints (intermediate locations that the route must pass through). The index (n value) for the set of waypoints and viaWaypoints is an integer starting with **0** or **1**. The waypoint and viaWaypoint index values must be sequential and must always increment by 1.<br/><br/>Both waypoint and viaWaypoint locations can be specified as a Point, a landmark, or an address. For more information about Point values, see [Location and Area Types](../common-parameters-and-types/location-and-area-types.md).<br/><br/>You can have a maximum of 25 waypoints or viaWaypoints in a request. The start and end points of the route cannot be viaWaypoints.<br/><br/>**GET Examples**:<br/><br/>waypoint.1=47.610,-122.107 \[Point\] <br/><br/>wp.1=Seattle,WA \[landmark\]<br/><br/>waypoint.1=1%20Microsoft%20Way%20Redmond%20WA%20 \[address\]<br/><br/>&waypoint.1=Seattle&viaWaypoint.2=Kirkland&waypoint.3=Redmond \[viaWaypoint\]<br/><br/>**POST Examples:** <br/><br/>"waypoints": \[{<br/> "latitude": 47.610,<br/> "longitude": -122.107<br/>},{<br/> "address": "Seattle",<br/> "isViaPoint": true<br/>},{<br/> "address": "1 Microsoft Way, Redmond, WA",<br/>}\] | | |||
| | `avoid` | | **Optional.** Specifies the road types to minimize or avoid when a route is created for the driving travel mode. A comma-separated list of values from the following list that limit the use of highways and toll roads in the route. In the definitions below, "highway" also refers to a "limited-access highway". If no values are specified, highways and tolls are allowed in the route. Can consist of the following values:<br/><br/> • **highways**: Avoids the use of highways in the route.<br/> • **tolls**: Avoids the use of toll roads in the route.<br/> • **ferry**: Avoids the use of ferries in the route.<br/> • **minimizeHighways**: Minimizes (tries to avoid) the use of highways in the route.<br/> • **minimizeTolls**: Minimizes (tries to avoid) the use of toll roads in the route.<br/> • **borderCrossing**: Avoids crossing country/region borders in the route.<br /> • **minimizeDrivingSideTurn**: In right-side-driving regions, this is to minimize right turns. In left-side-driving regions, this is to minimize left turns.<br /> • **minimizeAgainstDrivingSideTurn**: In right-side-driving regions, this is to minimize left turns. In left-side-driving regions, this is to minimize right turns.<br /> • **minimizeUTurn**: This is to minimize U-turns in the route.<br /><br/> **Note:** If you specify more than one option for a road type, then the most restrictive option is used. For example, if you set the avoid parameter to both *highways* and *minimizeHighways*, the *highways* option is used and all highways are avoided.<br/><br/> **Examples**:<br /> `avoid=highways`<br /><br /> `avoid=highways,tolls` <br /><br /> `avoid=borderCrossing`| | |||
| | `borderRestriction` | | **Optional, POST Requests only.** Specifies the border crossing preference with respect to countries, dependent territories, special areas of geographical interest, states, subdivision, or provinces. Consists of the following values:<br/><br/> • **RestrictionType**: is an enum that specify whether border crossing should be avoided, allowed, or minimized. <br/> <ul><li>`avoidCrossing` : Avoid border or boundary crossing as specified in `restrictionList`. </li> <li>`minimizeCrossing`: Minimize border or boundary crossing as specified in `restrictionList`. </li> <li>`allowedRegions`: Restrict the route only through the specified regions as specified in `restrictionList`.</li></ul> • **RestrictionList**: Defines the list of regions that should be considered for `borderRestriction`. <br> <ul><li> Use the `ISO 3166-1 alpha-2 codes` standard (i.e., two-letter country codes defined in `ISO 3166-1`) to represent countries, dependent territories, and special areas of geographical interest: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. </li> <li> Use the `ISO 3166-2` standard for country subdivision codes, for example: https://en.wikipedia.org/wiki/ISO_3166-2:US and https://en.wikipedia.org/wiki/ISO_3166-2:CA .</li> <li>Can also take the special values: </li> <ul><li> `countryRegion`: Considers all borders for countries, dependent territories, or special areas of geographical interest for the `borderRestriction` preference. </li><li> `adminDistrict`: Consider all boundaries for states, subdivision, or provinces for the `borderRestriction` preference. </li /></ul></ul> <br /> **Note:** Currently, we only support boundary crossing at state, subdivision, or province level for **US** (United States of America) and **CA** (Canada). We will consider adding support for other countries/regions upon customer requests. <br/><br />**POST Examples**: <br/> • Avoid crossing state boundary of `US-CT` (Connecticut) during routing. <br /><br />"borderRestriction": {<br/> "type": "avoidCrossing",<br/> "restrictions": ["US-CT"]<br/>}<br/> <br /> • Avoid crossing all country/region borders during routing. <br/><br />"borderRestriction": {<br/> "type": "AvoidCrossing",<br/> "restrictions": ["CountryRegion"]<br/>}<br />| | |||
| | `distanceBeforeFirstTurn` | `dbft` | **Optional.** Specifies the distance before the first turn is allowed in the route. An integer distance specified in meters. Use this parameter to make sure that the moving vehicle has enough distance to make the first turn.<br/><br/>**Examples**: distanceBeforeFirstTurn=500 | | |||
| | `distanceBeforeFirstTurn` | `dbft` | **Deprecated.** | | |||
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| @@ -115,9 +115,8 @@ The following is a list of parameters that are supported by the Isochrone API. | |||
| | `distanceUnit` | `du` | **Optional**. The units in which the maxDistance value is specified. One of the following values:<br/><br/> • **mile** or **mi**<br/> • **kilometer** or **km** \[default\]<br/><br/>**Example**: distanceUnit=mi | | |||
| | `dateTime` | `dt` | **Optional** **for time based Driving and Transit**. When a maxTime value is specified, predictive traffic data is used to calculate the best isochrone route for the specified date time. This is not supported for distanced based queries.<br/><br/>A string that contains the date and time formatted as a [DateTime](https://msdn.microsoft.com/library/03ybds8y.aspx) value. For information about the string representation options for DateTime values, see [DateTime.Parse Method (String)](https://msdn.microsoft.com/library/1k1skd40.aspx). <br/><br/>**Examples**:<br/><br/>dateTime=03/01/2011 05:42:00<br/><br/>dateTime=05:42:00 \[assumes the current day\]<br/><br/>dateTime=03/01/2011 \[assumes the current time\] | | |||
| | `optimize` | `optmz` | **Optional.** Specifies what parameters to use to optimize the isochrone route. One of the following values:<br/><br/> • **distance**: The route is calculated to minimize the distance. Traffic information is not used. Use with maxDistance.<br/> • **time** [default]: The route is calculated to minimize the time. Traffic information is not used. Use with maxTime.<br/> • **timeWithTraffic**: The route is calculated to minimize the time and uses current or predictive traffic information depending on if a dateTime value is specified. Use with maxTime.<br/><br/>**Example:** optimize=distance | | |||
| | `travelMode` | `mode` | **Optional.** Indicates the which routing profile to snap the points to. Possible values:<br/><br/> • **driving** \[default\]<br/> • **transit**<sup>1</sup><br/>• **truck** <br/><br/><br/>**Example:** travelMode=driving <br/><br /> **Note**: <br/><br/> For travelMode=truck, the vehicle attributes can be defined in the POST body. Please see the template POST body with vehicle attributes below this table. For more details about vehicle attributes, please check the [Calculate a Truck Route API doc](./calculate-a-truck-route.md). <br /><br /> **Geographic Availability**: <br /> - `Driving` is available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea. <br /> - `Truck` is available in Truck Routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md). <br /> - `Transit` is available in markets seen in the [Transit Coverage documentation](../../coverage/transit-coverage/index.md). | | |||
| | `travelMode` | `mode` | **Optional.** Indicates the which routing profile to snap the points to. Possible values:<br/><br/> • **driving** \[default\]<br/> • **truck** <br/> • ~~transit~~ \[deprecated\]<br/><br/>**Example:** travelMode=driving <br/><br /> **Note**: <br/><br/> For travelMode=truck, the vehicle attributes can be defined in the POST body. Please see the template POST body with vehicle attributes below this table. For more details about vehicle attributes, please check the [Calculate a Truck Route API doc](./calculate-a-truck-route.md). <br /><br /> **Geographic Availability**: <br /> - `Driving` is available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea. <br /> - `Truck` is available in Truck Routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md). | | |||
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"? Why is it in square brackets?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| | `vehicleHazardousMaterials` | `vhm` | **Optional**. A comma separated and case-sensitive list of one or more hazardous materials for which the vehicle is transporting. Possible values and their aliases are:<br/><br/> • **Combustable** or **C**<br/> • **Corrosive** or **Cr**<br/> • **Explosive** or **E**<br/> • **Flammable** or **F**<br/> • **FlammableSolid** or **FS**<br/> • **Gas** or **G**<br/> • **GoodsHarmfulToWater** or **WH**<br/> • **Organic** or **O**<br/> • **Other**<br/> • **Poison** or **P**<br/> • **PoisonousInhalation** or **PI**<br/> • **Radioactive** or **R**<br/> • **None**<br/><br/>**Examples**<br/><br/>vehicleHazardousMaterials=Explosive,Corrosive<br/><br/>vehicleHazardousMaterials=E,Cr | | ||
| | `vehicleHazardousPermits` | `vhp` | **Optional**. A comma separated and case-sensitive list of one or more hazardous materials for which the vehicle has a permit. Possible values and their aliases are:<br/><br/> • **AllAppropriateForLoad**<br/> • **Combustible** or **C**<br/> • **Corrosive** or **Cr**<br/> • **Explosive** or **E**<br/> • **Flammable** or **F**<br/> • **FlammableSolid** or **FS**<br/> • **Gas** or **G**<br/> • **Organic** or **O**<br/> • **Poison** or **P**<br/> • **PoisonousInhalation** or **PI**<br/> • **Radioactive** or **R**<br/> • **None**<br/><br/>**Examples**<br/><br/>vehicleHazardousPermits=Explosive,Corrosive<br/><br/>vehicleHazardousPermits=E,Cr | | ||
| | `vehicleHazardousPermits` | `vhp` | **Deprecated**. | |
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| | `vehicleMaxGradient` | `vmg` | **Optional**. The maximum gradient the vehicle can drive measured in degrees.<br/><br/>**Example**: vehicleMaxGradient=10 | | ||
| | `vehicleMinTurnRadius` | `vmtr` | **Optional**. The minimum required radius for the vehicle to turn in the specified dimension units.<br/><br/>**Example**: vehicleMinTurnRadius=15 | | ||
| | `vehicleMaxGradient` | `vmg` | **Deprecated**. | | ||
| | `vehicleMinTurnRadius` | `vmtr` | **Deprecated**. | |
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| @@ -234,10 +226,10 @@ https://dev.virtualearth.net/REST/v1/Routes/TruckAsyncCallback?requestId={reques | |||
| | `vehicleAxles` | `axles` | **Optional**. The number of axles.<br/><br/>**Example**: vehicleAxles=3 | | |||
| | `vehicleTrailers` | `vt` | **Optional**. The number of trailers. <br/><br/>**Example**: vehicleTrailers=2 | | |||
| | `vehicleSemi` | `semi` | **Optional**. Indicates if the truck is pulling a semi-trailer. Semi-trailer restrictions are mostly used in North America. <br/><br/>**Example**: vehicleSemi=true | | |||
| | `vehicleMaxGradient` | `vmg` | **Optional**. The maximum gradient the vehicle can drive measured in degrees.<br/><br/>**Example**: vehicleMaxGradient=10 | | |||
| | `vehicleMinTurnRadius` | `vmtr` | **Optional**. The minimum required radius for the vehicle to turn in the specified dimension units.<br/><br/>**Example**: vehicleMinTurnRadius=15 | | |||
| | `vehicleMaxGradient` | `vmg` | **Deprecated**. | | |||
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| @@ -160,9 +158,9 @@ The following is a list of parameters that are supported by the Snap to Road API | |||
| | `points` | pts | **Required**. A set of points to snap to roads. If you have a large number of values, you can use the HTTP POST. Up to 100 points for synchronhous requests, and 1,000 points for asynchrnous requests.<br/><br/>For GET requests: lat0,lon0;lat1,lon1;...;latM,lonM<br/><br/>**Example**: points=37.77916,-122.42;32.71568,-117.16172;<br/><br/>For POST requests:<br/>\[{<br/> "latitude": lat0,<br/> "longitude": lon0<br/>},<br/>{<br/> "latitude": lat1,<br/> "longitude": lon1<br/>},<br/>.<br/>.<br/>.<br/>{<br/> "latitude": latN,<br/> "longitude": lonN<br/>}\]<br/><br/>**Example:**<br/><br/>"points": \[{<br/> "latitude": 37.77916,<br/> "longitude": -122.42<br/>},<br/>{<br/> "latitude": 32.71568,<br/> "longitude": -117.16172<br/>}\] | | |||
| | `interpolate` | intpl | **Optional**. Indicates if the space between the snapped points should be filled with additional points along the road, thus returning the full route path. Default: **false**<br/><br/>**Example**: interpolate=true | | |||
| | `includeSpeedLimit` | spdl | **Optional**. Indicates if speed limitation data should be returned for the snapped points. Default: **false**<br/><br/>**Example**: includeSpeedLimit=true | | |||
| | `includeTruckSpeedLimit` | tspdl | **Optional.** Indicates if speed limitation data should be returned for the snapped points. Default: **false**<br/><br/>**Example**: includeTruckSpeedLimit=true | | |||
| | `includeTruckSpeedLimit` | tspdl | **Deprecated.** | | |||
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| | `startTime` | **Optional for Driving**. Specifies the start or departure time of the matrix to calculate and uses predictive traffic data. This should be a date string in a format that can be parsed by [DateTimeOffset.Parse](https://msdn.microsoft.com/library/bb351654.aspx). This option is only supported when the travel mode is set to driving.<br/><br/>**Example**: startTime=2017-06-15T8:00:00-07:00 | | ||
| | `endTime` | **Optional for Driving**. If specified, a matrix based on traffic data with contain a histogram of travel times and distances for the specified resolution intervals (default is 15 minutes) between the start and end times. A start time must be specified for the request to be valid and the total time between start and end cannot be greater than 24 hours. This should be a date string in a format that can be parsed by [DateTimeOffset.Parse](https://msdn.microsoft.com/library/bb351654.aspx). This option is only supported when the travel mode is set to driving.<br/><br/>**Example**: endTime=2017-06-15T13:00:00-07:00 | | ||
| | `resolution` | **Optional for Driving**. The number of intervals to calculate a histogram of data for each cell where a single interval is a quarter of an hour. Can be one of the following values:<br/><br/> • **1** - 15 minutes<br/> • **2** - 30 minutes<br/> • **3** - 45 minutes<br/> • **4** - an hour<br/><br/>If start time is specified and `resolution` is not, it will default to an interval of 1 (15 minutes).<br/><br/>**Example**: resolution=2 | | ||
| | `endTime` | **Deprecated**. | |
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
| | `speedUnit` | spu | **Optional.** Indicates the units in which the returned speed limit data is in. Possible values:<br/><br/> • **MPH** – Miles per hour<br/> • **KPH** – Kilometers per hour \[default\]<br/><br/>**Example**: speedUnit=MPH | | ||
| | `travelMode` | mode | **Optional.** Indicates which routing profile to snap the points to. Possible values:<br/><br/> • **driving** \[default\]<br/> • **walking** <br/><br/>**Example:** travelMode=driving <br/><br /> **Note**: <br/><br/> For trucks, the vehicle attributes can be defined in the POST body. Please see the template POST body with vehicle attributes below this table. <br /><br /> For more details about vehicle attributes, please check the Calculate a Truck Route API doc: /bingmaps/rest-services/routes/calculate-a-truck-route. <br /><br /> **Geographic Availability**: <br /> - `Driving` and `Walking` available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea. <br />- `Truck` is available in markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md).| | ||
| | `travelMode` | mode | **Optional.** Indicates which routing profile to snap the points to. Possible values:<br/><br/> • **driving** \[default\]<br/> • **walking** <br/> • ~~truck~~ \[deprecated\]<br/><br/>**Example:** travelMode=driving <br/><br /> **Geographic Availability**: <br /> - `driving` and `walking` available in routing markets seen in the [Geographic Coverage documentation](../../coverage/geographic-coverage.md) with the exception of China, Japan, and Korea.| |
There was a problem hiding this comment.
Is there any additional information that can be given beyond "deprecated"? Why is it in square brackets?
Has it been deprecated (slated for retirement, meaning it will no longer be supported after a certain date) or retired (no longer supported)?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of 09/30/2024, a number of API changes went into effect - please see the individual API for changes.