×
  (c) Pilot Telematics, 2024

Add vehicle to account

To add a vehicle to your account, use this API.

Example

API Request:

https://<address>/backend/api.php?cmd=vehadd&account_id=4019&type=1&name=testveh&imei=80987898789987&vehmodel=13&msisdn=7903

How to retrieve data

Method

POST

Request address

To retrieve data, use the address:https://<address>/backend/api.php?
<address> — the website address
 

Request parameters

To obtain the required data, append parameters to the request address. Parameters are specified after the question mark ? and are separated by the ampersand &.

Mandatory parameters

  • cmd=vehadd — command to add a vehicle
  • account_id — contract number in the system
  • vehmodel — model of the monitoring device. The model ID is obtained from the response of the vehmodellist command.
  • imei — unique number of the monitoring device
  • type — type of vehicle. The vehicle type ID is obtained from the response of the vehtypelist command. If the required type is not in the list, a new ID can be specified.
  • name — state registration number or name of the vehicle
  • msisdn — number of the primary SIM card of the device
  • msisdn2 — number of the secondary SIM card of the device
  • mac — MAC address, identifier of the vehicle's device. If the mac parameter is specified, the system will automatically create a record for the vehicle in the "Buses" tab in the admin panel.

Additional parameters

  • folder — name of the folder for adding the vehicle. If the specified folder does not exist, it will be created. If no folder is specified, the vehicle will be added to the general list (root folder).
  • info — additional information about the vehicle
  • summer_fuel — fuel consumption in the summer period
  • winter_fuel — fuel consumption in the winter period
  • fuel_type — type of fuel used (50-diesel, 80-92-95-98-gasoline, 100-gas). If the parameter is not specified, the system will automatically set it to diesel.
  • lost_connection_time — time after which a loss of connection is recorded (in seconds)
  • time_zone — time zone of the vehicle. Default is set to Europe/Moscow.
  • initial_motor_hours — initial engine hour readings
  • driver_id — driver identifier
  • initial_mileage — initial mileage of the vehicle. If not specified, it is considered to start from zero.
  • speed_limit — maximum allowable speed. If not specified, speed control is disabled.
  • minsat — minimum number of satellites. Default is set to 4.
  • maxhdop — maximum HDOP. Default is set to 21.
  • mintime — minimum parking time for track splitting. Default is set to 3600 seconds.
  • maxspeed — maximum possible speed. Default is set to 250.
  • minspeed — minimum speed for detecting the start of movement. Default is set to 10 km/h.
  • minparking — minimum parking time on the route. Default is set to 300 seconds.
  • model — make and model of the vehicle
  • year — year of manufacture of the vehicle. If the year is not specified, it defaults to 1900.
  • vin — vehicle identification number
  • engine_horse — engine power
  • organization — name of the owning organization
  • column — column number
  • subdivision — subdivision
     

Response to the equest

API Response

{
 "code": 0,
 "msg": "OK",
 "agent_id": "20518",
 "veh_id": "18994"
}
In response to the API request, the following is returned:
  • code — response code indicating how the request was processed
  • msg — message with a textual description of the operation result
  • agent_id — identifier of the agent that processed the request
  • veh_id — identifier of the vehicle to which this response pertain