v1
latestOpenAPI 3.0.02026-07-144229.6 KBReachable Range
Calculates a set of locations that can be reached from the origin point.
Path parameters
Service version number. The current value is 1.
Point from which the range calculation should start.
The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters.
Query parameters
Fuel budget in liters. Determines the maximum vehicle range using the specified Combustion Consumption Model.
Electric energy budget in kilowatt hours (kWh). Determines the maximum vehicle range using the specified Electric Consumption Model.
Time budget in seconds. Determines the maximum vehicle range using the specified driving time. The consumption parameters in the request will only affect eco-routes, and thereby indirectly the driving time.
Specifies the jsonp callback method.
Specifies which data should be reported for diagnosis purposes.
The date and time of departure from the origin point. Departure times apart from <i>now</i> must be specified as a dateTime.
The date and time of arrival at the destination point. It must be specified as a dateTime.
The type of route requested.
Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used.
Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified multiple times. Possible values:
- tollRoads
- motorways
- ferries
- unpavedRoads
- carpools
The mode of travel for the requested route.
Degree of hilliness for calculating a thrilling route.
Amount that a thrilling route should wind.
Maximum speed of the vehicle in km/hour.
Weight of the vehicle in kilograms.
Weight per axle of the vehicle in kg.
Length of the vehicle in meters.
Width of the vehicle in meters.
Height of the vehicle in meters.
Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads.
Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these for routing in the US:
- <i>USHazmatClass1</i> Explosives
- <i>USHazmatClass2</i> Compressed gas
- <i>USHazmatClass3</i> Flammable liquids
- <i>USHazmatClass4</i> Flammable solids
- <i>USHazmatClass5</i> Oxidizers
- <i>USHazmatClass6</i> Poisons
- <i>USHazmatClass7</i> Radioactive
- <i>USHazmatClass8</i> Corrosives
- <i>USHazmatClass9</i> Miscellaneous
Use these for routing in all other countries:
- <i>otherHazmatExplosive</i> Explosives
- <i>otherHazmatGeneral</i> Miscellaneous
- <i>otherHazmatHarmfulToWater</i> Harmful to water
vehicleLoadType can be specified multiple times. This parameter is currently only considered for <b>travelMode</b>=<i>truck</i>.
Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.
Specifies the current supply of fuel in liters.
Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed).
Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost).
Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed).
Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost).
Engine type of the vehicle.
Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.
Response
OK: a range was calculated and the body of the response contains the polygon description and further data.