Vehicle API - V2
Update vehicle.
Updates vehicle information by ID and returns the latest details.
Endpoint
PUT - https://api.travisroadservices.com/v2/vehicles/{id}
Copy
Path params
| Parameter | Type | Description |
|---|---|---|
id
|
string | Unique identifier of the vehicle. |
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
fuelCard
|
integer | No | ID of the fuel card to link to this vehicle. Used when a booking or transaction is made. |
fleetNumber
|
string | No | Fleet number to which this vehicle belongs. |
vehicleDepot
|
string (iri-reference) | No | Vehicle depot this vehicle is assigned to. The depot ID can be retrieved via the vehicle depot API. |
vin
|
string | No | VIN number of the vehicle. |
washFrequency
|
object | No | Wash frequency configuration for the vehicle. Only available for accounts with the control or automate subscription. |
inside
|
object | No | Inside wash frequency configuration for the vehicle. |
interval
|
integer | No | Maximum number of days allowed between inside washes. |
outside
|
object | No | Outside wash frequency configuration for the vehicle. |
interval
|
integer | No | Maximum number of days allowed between outside washes. |
isTravisPayDriveInEnabled
|
boolean | No | Whether travis pay is enabled for the vehicle |
Example
Response body
Response 200
VehicleResource resource updated
Fields
| Field | Type | Description |
|---|---|---|
id
|
integer | Unique identifier of the vehicle |
licensePlate
|
string | License plate of the vehicle. May contain alphanumeric characters, dashes, and spaces. Dashes and spaces are stripped before validation; minimum 4 characters, maximum 12. |
fuelCard
|
object | Fuel card linked to this vehicle, used when a booking or transaction is made. |
id
|
integer | Unique identifier of the fuel card. |
cardNumber
|
string | Card number of the fuel card. |
isMainCard
|
boolean | Indicates whether this is the main fuel card for the vehicle. |
status
|
string | Current status of the fuel card. |
fleetNumber
|
string | Fleet number to which this vehicle belongs. |
vehicleDepot
|
object | Vehicle depot this vehicle is assigned to. The depot ID can be retrieved via the vehicle depot API. |
id
|
object | Unique identifier of the vehicle depot. |
name
|
string | Name of the vehicle depot. |
vehicleType
|
object | Type of the vehicle. Available vehicle types can be retrieved via the vehicle type API. |
id
|
integer | Unique identifier of the vehicle type (integer). |
name
|
string | Human-readable name of the vehicle type. |
icon
|
string | URL of the vehicle type icon. May be null if no icon is assigned. |
vin
|
string | VIN number of the vehicle. |
washFrequency
|
object | Wash frequency configuration for the vehicle. Only available for accounts with the control or automate subscription. |
inside
|
object | Inside wash frequency configuration for the vehicle. |
interval
|
integer | Maximum number of days allowed between inside washes. |
status
|
string | |
lastWashedAt
|
string (date-time) | Date and time when the vehicle was last washed. |
outside
|
object | Outside wash frequency configuration for the vehicle. |
interval
|
integer | Maximum number of days allowed between outside washes. |
status
|
string | |
lastWashedAt
|
string (date-time) | Date and time when the vehicle was last washed. |
created
|
object | Information about when and by whom the vehicle was created. |
at
|
string (date-time) | Date and time when the resource was created. |
by
|
object | User or system that created the resource. |
id
|
integer | Identifier of the user which created the API Resource |
name
|
string | Name of the user which created the API Resource |
importId
|
string (uuid) | Identifier of the import batch this resource was created from. |
isDeletable
|
boolean | |
isTravisPayDriveInEnabled
|
boolean | Whether travis pay is enabled for the vehicle |
Example
Response 400
Invalid input
Fields
| Field | Type | Description |
|---|---|---|
title
|
string | A short, human-readable summary of the problem. |
detail
|
string | A human-readable explanation specific to this occurrence of the problem. |
status
|
integer | The HTTP status code applicable to this problem. |
instance
|
string | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type
|
string | A URI reference that identifies the problem type |
Example
Response 401
No response body - No bearer token set verify if your token is added as bearer tokenResponse 403
No response body - You don't have access to this API resourceResponse 404
Not found
Fields
| Field | Type | Description |
|---|---|---|
title
|
string | A short, human-readable summary of the problem. |
detail
|
string | A human-readable explanation specific to this occurrence of the problem. |
status
|
integer | The HTTP status code applicable to this problem. |
instance
|
string | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type
|
string | A URI reference that identifies the problem type |
Example
Response 422
An error occurred
Fields
| Field | Type | Description |
|---|---|---|
status
|
integer | The HTTP status code (422). |
violations
|
array | A list of constraint violations that caused the error. |
detail
|
string | A human-readable description of the validation errors. |
type
|
string | A URI reference identifying the validation error type. |
title
|
string | A short summary of the error. |
instance
|
string | A URI reference identifying the specific occurrence of the error. |
Example