Update vehicle by ID.

patch

https://api.interplai.io/v2/zones/{zoneId}/vehicles/{vehicleId}

Update information for an existing vehicle belonging to a zone.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

zoneId

string

required

Interplai-specified identifier of the zone.

vehicleId

string

required

Interplai-specified identifier of the vehicle.

Body Params

userVehicleId

string

User-specified identifier of the vehicle.

dutyMode

string

enum

A vehicle’s availability to perform mobility tasks.

onDuty : the vehicle and the driver are available to be assigned a mobility task.

onDutyPrivate : the vehicles and the driver are online but not available to use for an optimization solution.

offDuty : the driver and the vehicle are not available to accept any tasks.

Allowed:

speed

float

≥ 0

Maximum vehicle speed, in meters per second (m/s).

capacity

int32

≥ 0

Amount of cargo that the vehicle can carry.

fixedCost

int32

A set cost factor that may be assigned to a vehicle.

services

array of objects

A service is the category of mobility task a vehicle will be expected to carry out. Examples include food, flowers, laundry, etc.

services

driverName

string

Name of the driver assigned to the vehicle.

driverPhoneNumber

string

The phone number of the driver assigned to the vehicle.

licensePlateNumber

string

Vehicle's registration number.

coordinates

object

Responses

200Updated vehicle.

400Bad request.

401Invalid API key.

404Not found - zone or vehicle.