Create vehicle

Request

POST http:///fleet.roadprotect.co.il/api/v1/vehicle

Request body

The request body takes a complete CreateVehicleDto resource, containing the following writable properties:

{
    "category": "string",
    "color": "string",
    "manufacturer": "string",
    "model": "string",
    "modelYear": "string",
    "registration": "string",
    "type": "string",
    "weight": "number"
}

Properties

Name Type Description Additional
category string

The vehicle category class

 Optional
color string

The vehicle color

 Optional
manufacturer string

The vehicle manufacturer
model string

The vehicle model

 Optional
modelYear string

The year the vehicle was manufactured

 Optional
registration string

The vehicle registration number
type string

The type of vehicle in the fleet

Possible values are:

  • Private
  • Truck
 Optional
weight number

The vehicle weight in tonnes

 Optional

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created Vehicle
400 Bad Request

Vehicle not found
500 Internal Server Error

Failed to create vehicle, please contact the developers.