Get All Profiles

Contents

GET /routingprofiles #

Returns all custom routing profiles created in the account.

Resource URL #

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

Request #

Name Description Data Type
offset Pagination parameter to offset a collection of results from the server, indicating the cursor position at which the response begins
int
limit Pagination parameter indicating the number of results in the response
int

Response #

Name Description Data Type
href Pagination parameter that provides the URL to access the api resource
string
offset Pagination parameter to offset a collection of results from the server/indicating the cursor position at which the response begins
int
limit Pagination parameter indicating the number of results in the response
int
size vPagination parameter indicating the total number of pages that are available in the response.
int
routingProfileId Unique system generated identifier for a custom routing profile
int
Name Name of the custom profile. Must be unique in an account.
string
isAccountDefault Set to true if this profile should be used as a default profile for the account.
boolean
copilotOptions > displayRestrictions 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
region Specifies the region for which this profile was created: NA - North America; EU - Europe
string
vehicleType The vehicle type of the custom profile: Heavy Duty; Light Duty; Medium Duty; School Bus; Auto
int
units Units of measure for the custom profile vehicle dimensions
0: English (Default); 1: Metric
int
vehicleOptions > vehicleConfig > height The height of the vehicle in feet and inches or meters depending on units
double
vehicleOptions > vehicleConfig > width The width of the vehicle in feet and inches or meters depending on units
double
vehicleOptions > vehicleConfig > length The length of the vehicle in feet and inches or meters depending on units
double
vehicleOptions > vehicleConfig > weight The weight of the vehicle in pounds or kilos depending on units
double
vehicleOptions > vehicleConfig > maxWeightPerAxleGroup The maximum weight per axle group
double
vehicleOptions > governorSpeedLimit 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 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 (North America Only) Set to true to avoid tunnels with propane restrictions
boolean
vehicleOptions > tunnelCategory (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 (Europe Only) Array of strings that specifies which restriction zones will be avoided when using this custom profile. Options are: environmentalZones and congestionZones.
string
routingOptions > restrictionZones > allow (Europe Only) Array of strings that specifies which restriction zones will be allowed when using this custom profile. Options are: environmentalZones and congestionZones.
string
routingOptions > restrictionZones > warn (Europe Only) Array of strings that specifies which restriction zones will generate a warning when using this custom profile. Options are: environmentalZones and congestionZones.
string
routingOptions > useStateAndNationalNetwork (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 Indicates whether or not to avoid toll roads when generating a route. 1 - Always Avoid; 2 - Avoid if Possible; 3 - Use
int
routeOptions > useOpenBorders (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 Indicates whether or not to discourage the use of ferries when creating the route. 0 - Use; 1 - Discourage
boolean
routingOptions > elevationLimit (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
lastModified Indicates the last time the routing profile was modified
DateTime

Sample Request #

https://api.trimblemaps.com/routing/v1/routingprofiles?offset=0&limit=3

Sample Response #

{
  "href": "https://api.trimblemaps.com/routing/v1/routingprofiles",
  "offset": 0,
  "limit": 3,
  "size": 2,
  "first": {
    "href": "https://api.trimblemaps.com/routing/v1/routingprofiles?offset=0&limit=3&sortExpression=Name&sortDirection=ASC"
  },
  "data": [
    {
      "routingProfileId": 979392,
      "name": "panel-be8a9357-5341-49aa-88fd-0c4948b3e180",
      "isAccountDefault": false,
      "copilotOptions": {
        "displayRestrictions": 2
      },
      "region": "NA",
      "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
      }
    },
    {
      "routingProfileId": 979393,
      "name": "port-dad00b78-bcb2-4b74-9fa1-5c4f12338bda",
      "isAccountDefault": false,
      "copilotOptions": {
        "displayRestrictions": 2
      },
      "region": "NA",
      "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 February 19, 2021.