Mileage Report

The Mileage Report provides the mileage, time, and cost for each stop on the route.

Mileage Report Request

GET

URL Parameters

Required parameters are highlighted in yellow.

Mileage Report Specific Parameter

Data Element Description Data Type Value/Example
THoursWithSeconds flag to return THours to the seconds percision. HH:MM:SS Boolean

Response

Loading...
                        
                    

Mileaage Report Response.

Data Element Description Data Type Value/Example
type Describes the type of report and what it does. String MileageReport
RouteID The route identification key(Can be null) int
ReportLines Indicates the miles, time and cost for each stop on the route. Complex

ReportLines

Data Element Description Data Type Value/Example
Stops Describes the stops encountered on the route. Complex
Data Element Description Data Type Value/Example Note
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 Not Applicable
PlaceName The place name which corresponds to custom place. String Not Applicable
Errors Encapsulated the details about the errors associated with the geocode location List of Complex Objects
LMiles Miles spent on this leg of the route string
TMiles Indicates the total miles for that specific route stop. string
LCostMile Cost Miles spent on this leg of the route string
TCostMile Total cost miles spent on the route string
LHours Hours spent on this leg for the route string
THours Total hours on the route string
LTolls Tolls on this leg for the route string
TTolls Total tolls on the route string
LEstghg Estimated green house gas on this leg for the route string
TEstghg Total estimated green house gas on the route string
EtaEtd Estimated time of arrival or departure string

Address

Data Element Description Data Type Value/Example
StreetAddress The house number and street name string 495 Walker Road.
City The name of the city string Endicott
State The two letter state abbreviation string NY
Zip The postal code or zip string 13760
County The county or jurisdiction. string Broome
Country The name of the country string United States
SPLC The Standard Point Location code to use in place of street/city/state/zip String
CountryPostalFilter The postal code filter; use this to filter zip codes by country Enum Us
Em
Both
AbbreviationFormat The abbreviation format for the country code. This is not applicable for NA dataset Enum FIPS
ISO2
ISO3
CountryAbbreviation Abbreviated country code corresponding to requested format. string

Coords

Data Element Description Data Type Value/Example
Lat Latitude String 42.12345
Lon Longitute String -76.12345