Route Services

The route sub resource allows a user to retrieve a series of geographic coordinate point that make up a route with the supplied parameters. The Route Path API must be in the following form.

Data Element Description Data Type Value/Example
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
stopsAsViaPoints The via points you create can be designated as stops or waypoints. The “waypoint” designation means that these locations were added only to guide the route along desired roads. Waypoints are treated like stops on the map (routes travel through the centroid of a waypoint town or city), but they don’t appear in the driving instructions in the Driver’s Directions Report and are marked as a “Via” in the Detailed route Report. Waypoints appear on the stop list as circles with a gray border.
When provided true, all stops between the first and last are as via points.
boolean True/False
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
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
tollAvoid Indicates whether or not to avoid tolls 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 vehDimUnits.
Valid range is between 5' and 15' for English Unit, or between 1.524 and 5 meters for Metric Unit.
string 13'6" or 4.1148
vehLength The length of the truck in feet and inches or meters depending on vehDimUnits.
Valid range is between 8' and 70' for English Unit, or between 2.4384 and 28 meters for Metric Unit.
string 13'6" or 4.1148
vehWidth The width of the truck in inches or meters depending on vehDimUnits.
Valid range is between 60" and 102" for English Unit, or between 1.524 and 3 meters for Metric Unit.
string 96" or 2.44
vehWeight The weight of the truck in pounds or kilograms depending on vehDimUnits.
Valid range is between 1500 and 156470 lbs for English Unit, or between 680.39 and 60000 kgs for Metric Unit.
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
estimatedTimeOpts Estimated time options affects routing only when roads 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
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 decimal hours.
hosRemDriveTime The available driving hours at origin until the end of work day. double The format is in decimal hours.
hosRemOnDutyTime The available On-Duty hours available at origin until the end of work day. double The format is in decimal hours.
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 decimal hours.
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 distance units.
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
dataset The Regional dataset. Enum PCM_EU
PCM_OC
PCM_SA
PCM_ME
PCM_AS
PCM_AF
PCM_WW(Worldwide)
PCM_GT(GeoTrack)
Current(default)
PCM23-PCM31 (routePath only)
classOvrdtype A comma-separated list of class overrides. Enum 0 - None (Default)
1 - NationalNetwork
2 - FiftyThreeFoot
vehProfile Indicates the vehicle profile which is a preset collection of dimensions and routing options. Enum 0 - None (Default)
1 - TwentyEightDoubleTrailer
2 - FortyStraightTruck
3 - FortyEightSemiTrailer
4 - FiftyThreeSemiTrailer
5 - FullSizeVan
6 - TwentySixStraightTruck
7 - ConventionalSchoolBus
8 - SmallSchoolBus
trkUnits Vehicle dimension units. Enum 0 - English (Default)
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 0 - None (default)
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)
afSetIDs Apply the avoid/favor sets to the route. Int Array Default is none, i.e. empty list.
afSetNames Apply the avoid/favor sets to the route. String Array Default is none, i.e. empty list.
reduceResponsePoints Indicates whether to reduce the number of response points. Boolean True
False (Default)
elevLimit Indicates the elevation limit when generating a route. Elevation unit is specified in feet or meters. uint
ferryDiscourage Indicates whether or not to discourage the use of ferries when creating the route. Boolean True
False (Default)
useSites Indicates whether or not the route stops are on sites and to accordingly consider site gates. Boolean True
False (Default)
includePLIDs Include whether to include PLID metadata for the generated route. Boolean True
False (Default)
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. Enum True
False (Default, except for school bus vehicle profiles where this option is true by default when unsupplied)