Set ELB Action

/v2/vehicles//setELBAction

This endpoint can be used to set ELB data or unlocks the ELB.

Parameters

id

The ID of the vehicle where the ELB is installed.

action

The data structure where is specified the action to take on the ELB.

The description of the data structure follows:

{
  "action": "masterPin",
  "value": "string"
}

FieldDescription
action Specified the action to take regarding the ELB.
The available actions are:
NameDescription
masterPinSets the master PIN
driverPinSets the driver PIN
notesSaves the text in specified in the field value.
unlockSends a ELBUNLOCK command to the device

string/enum
value The value to be applied with the specified action. string

There are some validations performed on the data speficied in this structure:

  • If action is equal to "masterPin"
    It is expected that the the value in field value is the number of a pin. This number must be in the interval [1-999999].

  • If action is equal to "driverPin"
    It is expected that the the value in the field value is the number of a pin. This number must be in the interval [0-999999]

  • If action is equal to "notes"
    The text specified in the field value must have a maximum of 250 characters.

Response

true
If the action was executed without errors

false
If the action was not executed.

Response HTTP Codes

200 - OK

If the a command was correctly put in the list of commands to be send to the device.

400 - Bad request

  • If the parameter action is null or was not provided
  • If the data provided in the parameter action is considered not valid.

403 - Forbidden

  • If the user doesn't have permission to manage the lock system

404 - Not found

  • If the value specified in the parameter id does not belong to a vehicle that the user can view.