Comparison (LeastCost) Report

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.

LeastCost Report Request


URL Parameters

Required parameters are highlighted in yellow.



Comparison Report

Data ElementDescriptionData TypeValue/Example
typeDescribes the type of report and what it does.stringLeastCost
RouteIDThe route identification key(Can be null)Int
OriginWhere the route started fromComplex
Data ElementDescriptionData TypeValue/Example
AddressEncapsulates the details about the locationComplex
CoordsEncapsulates the details about the longitude/latitudeComplex
RegionIndicates the region of the locationEnum
LabelThe label to be displayed on maps and reports in association with a stopstring
PlaceNameThe place name which corresponds to custom place.string
ErrorsEncapsulated the details about the errors associated with the geocode locationList of Complex Objects
DestinationWhere the route ends at.ComplexSee Origin row above
ReportLinesReport details, including distance and cost.Complex
Data ElementDescriptionData TypeValue/Example
LeastCostTripOptionsprovides the type of trip it will be and whether to avoid tolls or not.stringPractical Tolls Allowed
RouteThe different available routesstringRoute 1
MilesThe miles that it will take on a specific routedouble0.2
CostThe cost on a specific routedouble0.25
HoursThe time it will take to travel on a specific routetime0:01
TollsThe amount of tolls one will experience on a specific routedouble0.00
LaborAmount of labor it will take on a specific routedouble0.00