getRouteOptions

Command

Retrieves current route options

Reads back the routing and display preferences currently in force: how routes are optimised, which road types are allowed, whether traffic is taken into account, the unit system and the map theme.

Mostly used to establish a starting point before changing anything with setRouteOptions, or to confirm that a configuration pushed earlier is still the one in effect.

Command#

{
  "jsonrpc": "2.0",
  "method": "getRouteOptions",
  "id": "1"
}

Response#

Success#

{
  "jsonrpc": "2.0",
  "result": {
    "routeMode": "FASTEST",
    "crossing": true,
    "ferry": true,
    "motorway": true,
    "sideArrival": false,
    "toll": true,
    "traffic": false,
    "autoReroute": true,
    "unpaved": true,
    "altRoutes": true,
    "units": "METRIC",
    "showVehicleProfileName": false,
    "showRestrictions": false,
    "mapDisplayMode": "LIGHT"
  },
  "id": "1"
}

• routeMode Possible values [FASTEST|SHORTEST].
• crossing Allow or disallow border crossing (if possible)
• ferry Ferry allowed
• motorway Motorway allowed
• sideArrival Arrival on defined destination side or not
• toll Toll roads allowed
• traffic Take into account traffic jams during route calculations (if traffic service available)
• autoReroute Auto-reroute when traffic information is updated (if traffic is enabled)
• unpaved Unpaved roads allowed
• altRoutes Alternative routes enabled or disabled
• units Possible values [METRIC|IMPERIAL].
• showVehicleProfileName Show vehicle profile's name on the map
• showRestrictions Show vehicle restrictions on map
• mapDisplayMode Possible values [LIGHT|DARK|AUTO].

Error#

Generic errors.