iotoms Docs

Update a vehicle

PUT
/api/v1/ops/vehicles/{vehicleId}

Replaces all details of a vehicle with the values you send: optional fields you leave out are cleared. The vehicle number must stay unique. Changing the status to anything other than ACTIVE stops new user assignments.

How to use it

  1. Fetch the vehicle with Get a vehicle.
  2. Send the full set of fields (vehicleNumber, vehicleType, status, label, odometer, notes); anything left out is cleared or reset.
  3. The vehicle is updated; setting a status other than ACTIVE means users can no longer be assigned to it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

vehicleId*string

Vehicle identifier, from List vehicles.

Formatuuid

Header Parameters

Request Body

application/json
  1. body
vehicleNumber*string

Registration or fleet number. Required and must not be used by another vehicle.

vehicleLabel?|

Optional friendly name. Also used to name the vehicle's van stock location.

vehicleType*string

Required. VAN, CAR, MOTORBIKE, FOOT (salesperson on foot) or OTHER.

Value in"VAN""CAR""MOTORBIKE""FOOT""OTHER"
status*string

ACTIVE (default), INACTIVE, ARCHIVED or DELETED. Users can only be assigned to ACTIVE vehicles.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
lastOdometerKm?|

Optional odometer reading in kilometres; zero or more.

Formatint32
notes?|

Optional free-text notes.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The vehicle.

Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/ops/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "vehicleNumber": "string",  "vehicleType": "VAN",  "status": "ACTIVE"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "vehicleNumber": "string",    "vehicleLabel": "string",    "vehicleType": "VAN",    "status": "ACTIVE",    "lastOdometerKm": 0,    "notes": "string",    "assignment": {      "property1": {        "assignmentId": "dbf5135c-beb7-4185-80db-2e980c77381b",        "userId": 0,        "username": "string",        "assignmentRole": "string",        "assignedAt": "2019-08-24T14:15:22Z",        "assignedBy": "string",        "isActive": true      },      "property2": {        "assignmentId": "dbf5135c-beb7-4185-80db-2e980c77381b",        "userId": 0,        "username": "string",        "assignmentRole": "string",        "assignedAt": "2019-08-24T14:15:22Z",        "assignedBy": "string",        "isActive": true      }    }  }}