Reports

The routeReports sub resource allows a user to retrieve a report data for a route with the supplied parameters. For each route, a minimum of two stops and report type is required. The report response returns a list of reports in JSON format. The type of report that was requested will define the content of the reported response.

Report Request Parameters

tr>
Data Element Description Data Type Value/Example
routeId routeId is used to identify the current report request. String NewYorkToLA
stops The coordinates that make up the stops of the route. List of comma-separated long.lat pairs, separated by semi-colons. -76.12345,42.12345
-76.12312,42.12312
-76.12456,42.12456
vehType The vehicle type Enum 0 - Truck
1 - LightTruck
2 - Auto
routing The desired routing algorithm Enum 0 - Practical
1 - Shortest
2 - Fastest
hwyOnly Indicates whether to use highways only boolean True/False
CustRdSpeeds Indicates whether to use custom road speeds. boolean True/False
useAvoidFavors Indicates whether or not to use avoid favors while routing boolean True/False
overrideClass A comma separated list of class overrides.
Note if if vehLength is larger than 48' (e.g. 48.1') and/or vehWidth is larger than 96" (e.g. 96.1"), then overrideClass is set to 3(National Network + FiftyThreeFoot) without an option to turn it off;
if vehLength is smaller than 48'and vehWidth is smaller than 96", then overrideClass is set to 0(None) by default. However, you can still provide overrideClass param to override it.
Enum 0 - None
1 - FiftyThreeFoot
2 - NationalNetwork
3 - NationalNetwork and FiftyThreeFoot
distUnits Distance Units. Enum 0 - Miles
1 - Km
fuelUnits Fuel Units Enum 0 - Gallons
1 - Liters
tollAvoid Indicates whether or not to avoid tolls boolean True/False
ferryDist Indicates whether or not to include ferry distances in mileage calculations. boolean True/False
borders Indicates whether borders are open to travel. boolean True/False
ovrdRestrict Indicates whether or not to override truck boolean True/false
hazMat Indicates the hazardous material type. See details in Glossary. Enum 0 - None
1 - General
2 - Caustic
3 - Explosives
4 - Flammable
5 - Inhalants
6 - Radioactive
routeOpt Indicates the method by which to optimize route stops. Enum 0 - None
1 - ThruAll
2 - DestinationFixed
lang Language Enum 0 - ENUS
1 - ENGB
2 - DE
3 - FR
4 - ES
5 - IT
hubRouting Indicates whether or not to enable hub routing boolean True/False
vehDimUnits Vehicle dimension units Enum 0 - English
1 - Metric
vehHeight The height of the truck in feet and inches or meters depending on units. string 13'6" or 4.1148
vehLength The length of the truck in feet and inches or meters depending on units. string 13'6" or 4.1148
vehWidth The width of the truck in feet and inches or meters depending on units. string 13'6" or 4.1148
vehWeight The weight of the truck in pounds or kilograms depending on units. string
Axles The number of axles on the truck int Acceptable values are 2 through 14 and the default value is 5
truckConfig The truck style. Enum 0 - None
1 - TwentyEightDoubleTrailer
2 - FortyStraightTruck
3 - FortyEightSemiTrailer
4 - FiftyThreeSemiTrailer
5 - FullSizeVan
6 - TwentySixStraightTruck
LCV Indicates whether the truck is a multi-trailer or longer combination vehicle. boolean True/False
useTraffic Indicates whether or not use traffic which is only used in conjunction with fastest routing. boolean True/False
reports Indicates which report data to return. Enum 0x0 - None
0x1 - Mileage
0x2 - Detail
0x4 - CalcMiles
0x8 - Directions
0x10 - Fuel
0x20 - Geotunnel
0x40 - LeastCost
0x80 - Road
0x200 - State
0x400 - WeatherAlerts
Note that this enumeration supports flags, meaning that more than one value can be set.
reportFmt Indicates the format of the report. Enum 3 - JSON
inclTollData Indicates whether or not toll data should be used. boolean True/False
fuelEconLoad The fuel efficiency(distance units per fuel units) when loaded. double value is decimal such as 11.9
fuelEconEmpty The fuel efficiency(distance units per fuel units) when empty. double value is decimal such as 11.9
costPerFuelUnit The cost per fuel unit of fuel. double value is decimal such as 4.15
costGHG The cost of greenhouse gas in lbs per fuel unit. double
costMaintLoad The maintenance cost per distance unit when loaded. double
costMaintEmpty The maintenance cost per distance unit when empty. double
costTimeLoad The time cost per mile when loaded. double
costTimeEmpty The time cost per mile when empty. double
tollCurrency The toll currency US is default in NA and EUR is default in Europe. Enum 0 - US
1 - CDN
For Toll Detail Report values below start at 2 (ALL) through 26 (UAH) ALL - Albanian lek AMD - Armenian dram AZN - Azerbaijani manat BAM - Bosnia and Herzegovina convertible mark BGN - Bulgarian lev BYR - Belarusian ruble CHF - Swiss franc CZK - Czech koruna DKK - Danish krone EUR - Euros GBP - Pound sterling GEL - Georgian lari HRK - Croatian kuna HUF - Hungarian forint ISK - Icelandic króna: second króna MDL - Moldovan leu MKD - Second Macedonian denar NOK - Norwegian krone PLN - Polish złoty RON - Fourth Romanian leu RSD - Serbian dinar RUB - Russian ruble SEK - Swedish krona TRY - Turkish lira UAH - Ukrainian hryvnia
exchangeRate The change rate to convert US dollars to Canadian dollars. double
tollPlan The toll discount plan which is a comma separated list of toll discount programs. string All, 407ETR Transponder, B-Pass, BreezeBy, C-Pass, Cruise Card, E-Pass, E-Pass Canada, EXpress Toll, EZ Tag, EZPass-WV, FAST LANE, FasTrak, Geaux Pass, Good To, GO-PASS, I-Pass, I-Zoom, K-TAG, Laredo Trade Tag, LeeWay, MACPA SS, Palmetto Pass,
PikePass, Quick pass, Smart Tag, StraitPASS, SunPass, TollTag, TxTag, Wabash Pass
citeInt(Required when a geotunnel report is requested) The cite interval to be used when generating a geotunnel report double Anything>= 0.1
hosEnabled Indicates whether or not to enable Hour of Service option. boolean True/False
hosRemDriveTimeUntilBreak The available driving hours at origin before the driver needs to take a rest break. double The format is in seconds.
hosRemDriveTime The available driving hours at origin until the end of work day. double The format is in seconds.
hosRemOnDutyTime The available On-Duty hours available at origin until the end of work day. double The format is in seconds.
hosRuleType The hours of service rule to use. Enum Valid values are 0 - USFed607LH, or 1 - USFed708LH for US Federal Long Haul rules.
hosRemCycleDutyTime The available Cycle time duty hours at origin until Cycle reset. double The format is in seconds.
sideOfStreetAdherence How strict to be in order to avoid the destination being on the opposite side of the street. Enum 0 - off
1- Minimal
2 - Moderate
3 - Average
4 - Strict
5 - Adhere
6 - StronglyAdhere
governorSpeedLimit Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Default is disabled and valid value is between 1 and 100 mph. double The format is in mph or kph based on distUnits.
condenseDirections Flag indicating whether or not to condense the directions report. boolean True/False
elevLimit Indicates the elevation limit when generating a route. Default value is null.Elevation unit can be either meters or feet is determined by the distUnits parameter. Miles = feet, Kilometers = meters. Available for dataversions Current, PCM_NA, PCM29. Limit will be ignored if: Routing is deemed impractical with the limit, or a stop is located at an elevation higher than the limit. int 3000
ferryDiscourage Indicates whether or not to discourage the use of ferries when creating the route. Default: false boolean True/False
estimatedTimeOpts Estimated time options allows setting of departure or arrival time. This time will be reflected in mileage and detailed reports and can also affect routing with roads that have time based restrictions.
Format:
Depart(Arrive)|[DayOfWeek]|[TimeOfDay]
or Depart(Arrive)|[SpecificDateTime]|[TimeZone]
Supported timezones can be found here
String Examples:
Depart|Monday|18:30
Arrive|2014-03-04T08:15:30|Local
useAvoidFavors Indicate whether or not to use avoids and favors while routing.
This is only for legacy users based on road name and state. API key users should use afSetIDs.
boolean
useSites Indicates whether the stops are on Sites or not and accordingly considers Site Gates in Routing. The default value is false. boolean True/False
afSetIDs Indicate the avoid/favor set(s) to apply to the route. This is only for API key users. Legacy user should use useAvoidFavors. list of comma separated IDs 24,133,204
trlType The type of trailer. This and all trailer related information below is used for toll detail reports in Europe Enum 1 - None
2 - Caravan
3 - Trailer
trlCount The number of trailers and semi-trailers. Default is 0. For Toll Detail reports in Europe. int 0
trlMaxHt The maximum height of the trailer in feet and inches, or meters depending upon the units. Maximum and minimum values are 20' and 3' respectively. For Toll Detail reports in Europe. String 20'
trlMaxWt The maximum weight of the trailer in pounds or kilos, depending upon units. Acceptable range is 2000Kg to 60000Kg. For Toll Detail reports in Europe. int 30000
trlMaxAxles The maximum number of axles on the trailer. Acceptable values are 1 through 8. The default value is 1. For Toll Detail reports in Europe. int 1
isHybrid Indicates whether the vehicle has a hybrid engine. Default is false. For Toll Detail reports in Europe. boolean false
emiType The emission type of the engine. For Toll Detail reports in Europe. Enum 3 - EuroI
4 - EuroII
5 - EuroIII
6 - EuroIV
7 - EuroV
8 - EuroVI
minPoll Indicates whether vehicle is a minimum vehicle pollution. Default is false. For Toll Detail reports in Europe. boolean false
region The data region in which stop coordinates lie. Enum 0 - Unknown
1 - AF
2 - AS
3 - EU
4 - NA(default)
5 - OC
6 - SA
7 - ME
dataVersion For users licensed for multiple data versions or datasets. string PCM18 - PCM30
PCM_EU
PCM_OC
PCM_SA
PCM_ME
PCM_AS
PCM_AF
PCM_WW(Worldwide)
PCM_GT(GeoTrack)
Current(default)
stopCosts Specifies the "Stop Costs" for each stop on the route. Complex
classOvrdtype A comma-separated list of class overrides. Enum 0 - None
1 - NationalNetwork
2 - FiftyThreeFoot
trkUnits Vehicle dimension units. Enum 0 - English
1 - Metric
trkHeight The height of the truck in feet and inches (English) or meters (Metric) String Maximum value is 13'6" or 4.1148 meters. Default is 13'6" in all regions except Europe, which is 12'6".
trkLength The length of the truck in feet and inches (English) or meters (Metric). String Maximum value is 53 feet or 16.1544 meters. Default is 48 feet in all regions except Europe, which is 54"1'.
trkWidth The width of the truck in feet and inches (English) or meters (Metric). String This value may be 96" and below, 102" and above or 98". Default is 96" for all regions.
trkWeight The weight of the truck in pounds (English) or kilograms (Metric). String Acceptable values can be up to 132,000 pounds or 59,874 kilos. The default value is 80,000 pounds for all regions.
trkAxles Indicates the number of axles on the vehicle. Int Acceptable values are 2 through 14. Default is 5.
truckConfig Indicates the truck style. Enum Default is None which is equivalent to the 48 foot semi trailer profile. For Auto or light duty, use FullSizeVan. Possible values are:
0 - None
1 - TwentyEightDoubleTrailer
2 - FortyStraightTruck
3 - FortyEightSemiTrailer
4 - FiftyThreeSemiTrailer
5 - FullSizeVan
6 - TwentySixStraightTruck
7 - ConventionalSchoolBus
8 - SmallSchoolBus
trkLCV Indicates whether the truck is a multi-trailer or longer combination vehicle. Boolean True - Multi-trailer
False - Longer Combination Vehicle (Default)
breakInterval The elapsed time, in hours, of the trip before a break will be taken. Float
breakLength The amount of time, in hours, a break will last. Float
borderWait The amount of waiting time, in hours, at the border to add to the overall trip. Float
remHrsOfSvc The remaining hours of service at the start of the trip before the driver needs to take a break. Float
useTraffic Indicates whether or not use traffic data. Boolean Possible values are:
True
False (Default)
afSetNames Apply the avoid/favor sets to the route. The format is comma separated names. String array
tHoursWithSeconds Indicates whether to return THours with seconds precision for MileageReports. Boolean Possible values are:
1 - True
2 - False (Default)
urgency Indicates to retrieve weather alerts with an urgency attribute matching the listed values. Enum Possible values are:
0 - Immediate
1 - Expected
2 - Future
3 - Past
4 - Unknown
severity Indicates to retrieve weather alerts with an severity attribute matching the listed values. Enum Possible values are:
0 - Extreme
1 - Severe
2 - Moderate
3 - Minor
4 - Unknown
certainty Indicates to retrieve weather alerts with an certainty attribute matching the listed values. Enum Possible values are:
0 - Observed
1 - Likely
2 - Possible
3 - Unlikely
4 - Unknown
eventNames Lists the event names to match from the weather alerts when generating a report. String array
maintainHeading Indicates whether or not to maintain heading at intermediate stops by avoid u-turns and instead leaving the stop in the same direction it entered it. Boolean Possible values are:
1 - True
2 - False (Default is false expect for School bus profiles)
minPoll Indicates whether vehicle has a minimum vehicle pollution status. Boolean Possible values are:
1 - True
2 - False (Default)

POST Report Request Parameters

Alternatively, user can retrieve report data through a POST request in JSON format. The benefits of using a POST request are: in Stops object, user can pass in either an Address object or Coords object. Also, user can add label to each Stops. Hours of service options also benefit from a POST request. Additional hours of service options to fully support Cycle Time Gains, use of custom places for rest stops, and Canadian hours of service are only available through the POST version of the request. See examples in Post Route Reports and Post Derived Route Reports.