|
| 1 | +<!--- This is a generated file, do not edit! --> |
| 2 | +<!--- [START woosmap_http_parameters_distancetolls] --> |
| 3 | +<h2 id="required-parameters">Required parameters</h2> |
| 4 | + |
| 5 | +- <h3 class="parameter-name" id="destination">destination</h3> |
| 6 | + |
| 7 | + The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values. |
| 8 | + |
| 9 | +- <h3 class="parameter-name" id="origin">origin</h3> |
| 10 | + |
| 11 | + The starting point. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values. |
| 12 | + |
| 13 | +<h2 id="optional-parameters">Optional parameters</h2> |
| 14 | + |
| 15 | +- <h3 class="parameter-name" id="alternatives">alternatives</h3> |
| 16 | + |
| 17 | + Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided. |
| 18 | + `alternatives` and `waypoints` can not be used at the same time. |
| 19 | + |
| 20 | +- <h3 class="parameter-name" id="arrival_time">arrival_time</h3> |
| 21 | + |
| 22 | + By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`). |
| 23 | + Use either `arrival_time` or `departure_time`, not both. |
| 24 | + |
| 25 | +- <h3 class="parameter-name" id="departure_time">departure_time</h3> |
| 26 | + |
| 27 | + By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`. |
| 28 | + Use either `arrival_time` or `departure_time`, not both. |
| 29 | + |
| 30 | +- <h3 class="parameter-name" id="language">language</h3> |
| 31 | + |
| 32 | + The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”. |
| 33 | + |
| 34 | +- <h3 class="parameter-name" id="method">method</h3> |
| 35 | + |
| 36 | + Specifies the method to compute the route between the start point and the end point: |
| 37 | + |
| 38 | + - `time`: fastest route (default) - `distance`: shortest route |
| 39 | + |
| 40 | +- <h3 class="parameter-name" id="mode">mode</h3> |
| 41 | + |
| 42 | + Specifies the mode of transport to use when calculating distance |
| 43 | + |
| 44 | +- <h3 class="parameter-name" id="units">units</h3> |
| 45 | + |
| 46 | + Specifies the unit system parameter to use when expressing distance as text. Two different units supported: |
| 47 | + |
| 48 | + - `metric` (default) returns distances in kilometers and meters |
| 49 | + - `imperial` returns distances in miles and feet |
| 50 | + |
| 51 | +- <h3 class="parameter-name" id="waypoints">waypoints</h3> |
| 52 | + |
| 53 | + A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character. |
| 54 | + Optionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed. |
| 55 | + `alternatives` and `waypoints` can not be used at the same time. |
| 56 | + |
| 57 | + |
| 58 | +<p style="text-align: right; font-size: smaller;">Generated from the <a data-label="openapi-github" href="https://github.com/woosmap/openapi-specification" title="Woosmap OpenAPI Specification" class="external">OpenAPI specification</a>. |
| 59 | +<a data-label="openapi-github-woosmap-http-parameters-distancetolls" data-action="edit" style="margin-left: 5px;" href="https://github.com/woosmap/openapi-specification/tree/main/specification/parameters" title="Edit on GitHub">✎ Edit</a> |
| 60 | +<a data-label="openapi-github-woosmap-http-parameters-distancetolls" data-action="bug" style="margin-left: 5px;" href="https://github.com/woosmap/openapi-specification/issues/new?assignees=&labels=type%3A+bug%2C+triage+me&template=bug_report.md&title=[parameters] Bug - /distance/tolls/json" title="File bug for parameters on GitHub"><span class="material-icons">bug_report</span> Report bug</a> |
| 61 | +</p> |
| 62 | + |
| 63 | +<!--- [END woosmap_http_parameters_distancetolls] --> |
0 commit comments