v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Vehicles

Create a vehicle

Required scope: vehicles:write

post/api/v1/vehicles

Request body

namestring required

Name of the vehicle

modelIdinteger nullable

Id of the vehicle model

teamIdinteger required

Id of the team the vehicle belongs to

licensePlatestring nullable

License plate of the vehicle

brandstring nullable

Manual vehicle brand name. Required when modelId is not provided.

modelNamestring nullable

Manual vehicle model name. Required when modelId is not provided.

vehicleTypestring nullable

Vehicle type. Required when modelId is not provided.

vidstring nullable

VID identifier for auto-charge (manual vehicles only). Format: VID:xxxxxxxxxxxx

Example request

{
  "name": "Viking Bus 42",
  "modelId": 1234,
  "teamId": 100,
  "licensePlate": "AB12345",
  "brand": "Volvo",
  "modelName": "FH Electric",
  "vehicleType": "truck",
  "vid": "VID:001681036794"
}

Response

Vehicle created