Comparison Report

The comparison report provides a detailed comparison between two different routes.

Comparison Report Request

GET

URL Parameters

Required parameters are highlighted in yellow.

Response

Loading...
                        
                    

Comarison Report

Data Element Description Data Type Value/Example
type Describes the type of report and what it does. String ComparisonReport
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 Turn by turn directions from origin. 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 double 0.00
Labor Amount of labor it will take on a specific route double 0.00