getVehicleProfile

Command

Retrieves details of a vehicle profile

Send this JSON-RPC message in the BND_MESSAGE extra of an Intent with the action ACTION_RNC_BROADCAST, to BeNav's activity or receiver: see Sending commands.

Reads back a profile in full: dimensions, weights, dangerous-goods class, speed limits, and the permission tier the driver has over it. Sent without an id, it returns whichever profile is currently active.

Useful for confirming that a device holds the definition head office believes it holds, and for showing the driver's current vehicle configuration inside the client application.

When an id is supplied it is echoed back unchanged. When it is omitted, the id in the response is the profile's internal identifier, which for an RNC-created profile carries an "RNC: " prefix. getVehicleProfilesList always returns ids without that prefix.

User created profiles can't be returned from their id.

Command#

text

{
  "jsonrpc": "2.0",
  "method": "getVehicleProfile",
  "params": {
    "id": "custom_profile_1"
  },
  "id": "1"
}

Response#

Success#

text

{
  "id": "1",
  "result": {
    "id": "custom_profile_1",
    "name": "Profile 1",
    "userPermission": "LOCKED",
    "userEditionAllowed": false,
    "majorRoads": true,
    "profile": {
      "height": 1.6,
      "length": 4.5,
      "width": 1.8,
      "weight": 1.5,
      "weightPerAxle": 0,
      "nbTrailers": -1,
      "hazmat": "NONE",
      "adr": "NONE",
      "maxSpeed": 130,
      "transportationMode": "PASSENGER_CAR",
      "drivingProfile": {
        "maxSpeedETA": 0,
        "maxSpeedCAL": 0,
        "averageAcc": 1.25,
        "averageDec": -1.25
      },
      "speedProfile": {
        "mainPond": 1,
        "secondaryPond": 1,
        "thirdPond": 1,
        "fourthPond": 0.75,
        "mainPondETA": 1,
        "secondaryPondETA": 1,
        "thirdPondETA": 1,
        "fourthPondETA": 0.75
      },
      "onlyPhysical": false
    },
    "category": "PASSENGER_CAR"
  },
  "jsonrpc": "2.0"
}

See editVehicleProfile for parameters definition.

Error#

Generic errors, or if the profile is not found:

json

{
  "id": "1",
  "jsonrpc": "2.0",
  "error": {
    "code": 27,
    "message": "profile.not.found.error"
  }
}