The Comparison (LeastCost) Report provides a detailed comparison of the distance, time and costs associated with multiple possible routes between an origin and a destination. The routes are generated by using combinations of Route Types (Practical, Shortest and Fastest) and whether or not to avoid tolls.
Parameters
This table includes the most frequently used parameters. Please see the Route Reports overview page for a full list. If you would like to test out this API, enter values in the table below and scroll down the page to submit your request. Required parameters are highlighted in yellow. Check the box next to any additional parameters you would like to set.
LeastCost Report Request
Comparison Report
Data Element
Description
Data Type
Value/Example
type
Describes the type of report and what it does.
string
LeastCost
RouteID
The route identification key(Can be null)
Int
Origin
Where the route started from
Complex
Data Element
Description
Data Type
Value/Example
Address
Encapsulates the details about the location
Complex
Coords
Encapsulates the details about the longitude/latitude
Complex
Region
Indicates the region of the location
Enum
Label
The label to be displayed on maps and reports in association with a stop
string
PlaceName
The place name which corresponds to custom place.
string
Errors
Encapsulated the details about the errors associated with the geocode location
List of Complex Objects
Destination
Where the route ends at.
Complex
See Origin row above
ReportLines
Report details, including distance and cost.
Complex
Data Element
Description
Data Type
Value/Example
LeastCostTripOptions
provides the type of trip it will be and whether to avoid tolls or not.
string
Practical Tolls Allowed
Route
The different available routes
string
Route 1
Miles
The miles that it will take on a specific route
double
0.2
Cost
The cost on a specific route
double
0.25
Hours
The time it will take to travel on a specific route
time
0:01
Tolls
The amount of tolls one will experience on a specific route