Create a Routing Profile

Contents

POST /routingprofiles #

Creates a new, custom Vehicle Routing Profile. The profile will be added to the FleetPortal account associated with your API key.

Resource URL #

https://api.trimblemaps.com/routing/v1/routingprofiles

Request #

The parameters that can be set in a Vehicle Routing Profile vary based on the type of vehicle and worldwide region. Select your region and vehicle type in the drop-down menu to view the available parameters.

Name Description Data Type
Name (Required) Name of the custom profile. Must be unique in an account. 
string
isAccountDefault (Optional) Set to true if this profile should be used as a default profile for the account. 
Boolean
copilotOptions > displayRestrictions (Optional) Display road restrictions to drivers in the CoPilot navigation screen
0: Show all restrictions
1: Show only restrictions for profile (Default)
2: Hide all restrictions 
int
vehicleType (Required) The vehicle type of the custom profile: Heavy Duty; Light Duty; Medium Duty; School Bus; Auto 
int
units (Optional) Units of measure for the custom profile vehicle dimensions.
0: English (Default for North America)
1: Metric (Default for Europe) 
int
vehicleOptions > vehicleConfig > height (Required) The height of the vehicle in feet and inches or meters depending on units 
double
vehicleOptions > vehicleConfig > width (Required) The width of the vehicle in feet and inches or meters depending on units 
double
vehicleOptions > vehicleConfig > length (Required) The length of the vehicle in feet and inches or meters depending on units 
double
vehicleOptions > vehicleConfig > weight (Required) The weight of the vehicle in pounds or kilos depending on units 
double
vehicleOptions > vehicleConfig > maxWeightPerAxleGroup (Required) The maximum weight per axle group 
double
vehicleOptions > governorSpeedLimit (Optional) Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. The format is in mph or kph based on units. The valid range is between 1 and 100 mph. 
int
vehicleOptions > hazmatType (Optional) Indicates the hazardous material type:
0 - None (Default); 1 - General; 2 - Caustic; 3 - Explosives; 4 - Flammable; 5 - Inhalants; 6 - Radioactive; 7 - HarmfulToWater; 8 - Tunnel 
int
vehicleOptions > isPropaneRestricted (Optional) (North America Only) Set to true to avoid tunnels with propane restrictions 
boolean
vehicleOptions > tunnelCategory (Optional) (Europe Only) When hazmatType is selected, allow the tunnelCategory parameter. None = 0 (Default); TunnelBCDE = 1; TunnelCDE = 2,TunnelDE = 3, TunnelE = 4 
int
routingOptions > restrictionZones > avoid (Optional) (Europe Only) Array of strings that specifies which restriction zones will be avoided when using this custom profile. Options are: environmentalZones and congestionZones. 
Array <string>
routingOptions > restrictionZones > allow (Optional) (Europe Only) Array of strings that specifies which restriction zones will be allowed when using this custom profile. Options are: environmentalZones and congestionZones. 
Array <string>
routingOptions > restrictionZones > warn (Optional) (Europe Only) Array of strings that specifies which restriction zones will generate a warning when using this custom profile. Options are: environmentalZones and congestionZones. 
Array <string>
routingOptions > useStateAndNationalNetwork (Optional) (North America Only) Set to true (Default for vehicles with width exceeding 96 inches or length exceeding 48 feet) to favor the U.S. Federally designated National Network and state-designated extensions to the National Network. 
boolean
routingOptions > routeType (Optional) The desired routing algorithm: 0 - Practical (Default); 1 - Shortest; 2 - Fastest 
enum
routeOptions > tollRoads (Optional) Indicates whether or not to avoid toll roads when generating a route. 1 - Always Avoid; 2 - Avoid if Possible; 3 - Use 
int
routeOptions > useOpenBorders (Optional) (North America Only) Sets whether or not international borders are open to travel. Set to false to minimize the number of international border crossings, unless they are necessary to reach all of the stops on a route. For example, if all your stops are in the “lower 48” United States, the resulting route will stay in the United States even if the most practical or shortest route would normally involve some Canadian mileage.

The true option ignores international boundaries in generating the best route. True (Default); False 

boolean
routingOptions > ferries (Optional) Indicates whether or not to discourage the use of ferries when creating the route. 0 - Use; 1 - Discourage 
boolean
routingOptions > elevationLimit (Optional) (North America Only) Sets a customized limit on the elevation of the roads a route will use. Limit will be ignored if routing is deemed impractical with the limit, or a stop is located at an elevation higher than the limit. Elevation unit can be either centimeters or feet, as determined by the units parameter. 
int

Response #

Name Description Data Type
message Indicates the status of the POST operation 
int
data Custom Routing Profile object 
object
lastModified Indicates the last time the routing profile was modified 
DateTime

Sample Request # 

{
  "name": "Test Profile",
  "vehicleType": "Heavy Duty",
  "units": 0,
  "vehicleOptions": {
    "vehicleConfig": {
      "height": 162,
      "width": 102,
      "length": 636,
      "weight": 80000,
      "maxWeightPerAxleGroup": 80000
    },
    "governorSpeedLimit": null,
    "hazmatType": 0
  },
  "routingOptions": {
    "useStateAndNationalNetwork": false,
    "routeType": 0,
    "elevationLimit": null
  }
}

Sample Response # 

{
  "message": "Successfully created routing profile.",
  "data": {
    "routingProfileId": 979393,
    "name": "Test Profile",
    "isAccountDefault": false,
    "copilotOptions": {
      "displayRestrictions": 2
    },
    "vehicleType": "Heavy Duty",
    "units": 0,
    "vehicleOptions": {
      "vehicleConfig": {
        "height": 162.0,
        "width": 102.0,
        "length": 636.0,
        "weight": 80000.0,
        "maxWeightPerAxleGroup": 80000.0
      },
      "governorSpeedLimit": null,
      "hazmatType": 0,
      "isPropaneRestricted": null,
      "tunnelCategory": null
    },
    "routingOptions": {
      "ferries": "Use",
      "restrictionZones": {
        "allow": [],
        "avoid": [],
        "warn": ["congestionZones", "environmentalZones"]
      },
      "useStateAndNationalNetwork": false,
      "routeType": 0,
      "tollRoads": 3,
      "useOpenBorders": false,
      "elevationLimit": null
    }
  }
}
Last updated April 14, 2021.