Vehicles

Get a vehicle by id

The same vehicle as under its location, found from its id. For a caller that holds an id and not the location it belongs to. The answer carries locationId.

get/v1/vehicles/{vehicleId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/vehicles/{vehicleId}
  • Auth: HTTP bearer

Path parameters

vehicleIdstring required

Response

OK

colourstring

From the vehicle register.

createdAtstring date-time
descriptionstring

What the vehicle is called in Cliento. A lookup in the vehicle register fills it in with the make, model, colour and year; staff can change it.

externalReferencestring

Your own id for it, as sent when it was created.

idstring required
locationIdstring required
makestring

From the Swedish vehicle register, when staff have looked the vehicle up in Cliento. Not set through the API.

modelstring

From the vehicle register.

modelYearinteger

From the vehicle register.

notesstring

Staff-facing notes, at most 1000 characters.

registrationNumberstring

The registration number, one to seven characters.

updatedAtstring date-time

Example response

{
  "colour": "Red",
  "description": "The red van",
  "externalReference": "crm-88121",
  "id": "veh_3Ks7pQx2Wn9Tb4Vd6HyRcE",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "make": "Volvo",
  "model": "V60",
  "modelYear": 2021,
  "registrationNumber": "ABC123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.