Road Speeds Object
Contents
Custom road speeds are speeds you assign to each road class to improve ETT and ETA calculations based on your fleet’s needs. If you are also licensed for traffic, custom road speeds will only be used as a cap. That is, if a road speed you set is below the historical or real-time traffic speed, that lower speed will be used in ETA calculations. Setting a governorSpeedLimit (maximum) speed will also override any custom road speeds.
In POST method calls to the Routing APIs, custom road speeds can be applied by:
- Setting the
UseCustomRoadSpeedsparameter toTruein the POST body. - Adding a
CustomRoadSpeedsobject to the POST body.
Turn on Road Speeds
Custom road speeds are turned on within the ReportingOptions object by setting UseCustomRoadSpeeds to True.
// Truncated JSON
"ReportingOptions": {
"EstimatedTimeOptions": {
"ETAETD": 0,
"DateOption": 0,
"DateAndTime": {
"CalendarDate": "",
"DayOfWeek": 3,
"TimeOfDay": "07:00",
"TimeZone": 0
}
},
"IncludeVehicleRestrictedCleanupPoints": true,
"UseTraffic": true,
"ExchangeRate": 1.26,
"FuelUnits": 0,
"IncludeFerryDistance": true,
"IncludeRoadClass": true,
"Language": 0,
"TollCurrency": 0,
"TollDiscount": "",
"UseCustomRoadSpeeds": true,
"UseEUTollsReport": false,
"UseTollData": true
},
Set Road Speeds
Road speeds are set within the CustomRoadSpeeds object, which is part of the route Options object. CustomRoadSpeeds is an array of speeds for each road class. By default, speeds are set in mph. Set DistanceUnits to 1 to set speeds in kph.
CustomRoadSpeeds parameters
| Parameter | Description | Data Type | Values |
|---|---|---|---|
| RoadCategory | The road type you are setting a custom road speed for. | Enum | InterStateRural = 1 DividedRural = 3 PrimaryRural = 4 FerriesRural = 5 SecondaryRural = 6 RampRural = 7 LocalRural = 8 InterStateUrban = 10 DividedUrban = 12 PrimaryUrban = 13 FerriesUrban = 14 SecondaryUrban = 15 RampUrban = 16 LocalUrban = 17 |
| Speed | The road speed that applies to a roadCategory.
| Int | |
| Jurisdiction | The state or country (outside of NA) abbreviation for the road speed data. | String | See list of abbreviations. |
// Truncated JSON
"Options": {
"VehicleType": 0,
"RoutingType": 1,
"HighwayOnly": true,
"FuelRoute": false,
"UseAvoidsAndFavors": false,
"ClassOverrides": 1,
"CustomRoadSpeeds": [
{
"RoadCategory": 1,
"Speed": 55,
"Jurisdiction": "PA"
},
{
"RoadCategory": 3,
"Speed": 55,
"Jurisdiction": "PA"
},
{
"RoadCategory": 4,
"Speed": 45,
"Jurisdiction": "PA"
},
{
"RoadCategory": 5,
"Speed": 15,
"Jurisdiction": "PA"
},
{
"RoadCategory": 6,
"Speed": 35,
"Jurisdiction": "PA"
},
{
"RoadCategory": 7,
"Speed": 15,
"Jurisdiction": "PA"
},
{
"RoadCategory": 8,
"Speed": 25,
"Jurisdiction": "PA"
},
{
"RoadCategory": 10,
"Speed": 60,
"Jurisdiction": "PA"
},
{
"RoadCategory": 12,
"Speed": 55,
"Jurisdiction": "PA"
},
{
"RoadCategory": 13,
"Speed": 45,
"Jurisdiction": "PA"
},
{
"RoadCategory": 14,
"Speed": 15,
"Jurisdiction": "PA"
},
{
"RoadCategory": 15,
"Speed": 35,
"Jurisdiction": "PA"
},
{
"RoadCategory": 16,
"Speed": 15,
"Jurisdiction": "PA"
},
{
"RoadCategory": 17,
"Speed": 25,
"Jurisdiction": "PA"
}
],
// Additional Settings
}