Adds new vehicle.

SecurityAPIKey
Request
Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

Name of the vehicle. Should be unique in group scope.

driverId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

ID of the driver which will be assigned to the vehicle.

deviceId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

Id of the device in the vehicle.

deviceSerialNumber
string or null [ 1 .. 50 ] characters

Serial number of the device in the vehicle.

type
integer <int32> [ 0 .. 32767 ]
Default: 0

By default, the vehicle will figure as unassigned.

groupId
required
string non-empty ^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

ID of the group where the vehicle will be assigned.

status
integer <int32> [ 1 .. 32767 ]
Default: 2

ID of the status of the vehicle. By default, the vehicle will figure as in service.

seatbeltType
integer <int32> [ 0 .. 32767 ]
Default: 1

ID of the seatbelt type in the vehicle. By default, the vehicle will have shoulder harness seatbelts.

licensePlateNumber
string or null [ 1 .. 50 ] characters

License plate number of the vehicle.

countrySubdivisionId
integer or null <int32> [ 0 .. 2147483647 ]

Id of the country subdivision.

vin
string or null = 17 characters ^[A-HJ-NPR-Z0-9]{17}$

VIN of the vehicle.

make
string or null [ 1 .. 250 ] characters

Make of the vehicle.

model
string or null [ 1 .. 250 ] characters

Model of the vehicle.

year
integer or null <int32>

Production year of the vehicle.

(HibernationDelay (string or null))

Hibernation delay of the vehicle.

Responses
201

Vehicle added.

400

The parameters given in the request are invalid.

401

Unauthorized due to providing an invalid access key, or invalid pod.

403

You have no permissions to make this operation.

409

Vehicle with provided name already exists.

500

Requested operation cannot be performed.

503

Requested operation cannot be performed. Try again later.

post/all
Request samples
application/json
{
  • "name": "string",
  • "driverId": "string",
  • "deviceId": "string",
  • "deviceSerialNumber": "string",
  • "type": 0,
  • "groupId": "string",
  • "status": 2,
  • "seatbeltType": 1,
  • "licensePlateNumber": "string",
  • "countrySubdivisionId": 2147483647,
  • "vin": "stringstringstrin",
  • "make": "string",
  • "model": "string",
  • "year": 0,
  • "hibernationDelay": "UseDefault"
}
Response samples
application/json
{
  • "vehicleId": "string"
}