Update a vehicle

Update the details of a single vehicle (required scope vehicles:write)

Path Parameters

vehicleId int64 required

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

groupId int64

The unique identifier of the group that the vehicle belongs to
Optional: Omit to retain current value

vehicleType VehicleType

Possible values: [motorcycle, car, trailer, bus, emergency, goodsLess7_5T, goodsMore7_5T, busLess12]

Enumeration representing different types of vehicles

Possible values:

• motorcycle: Motorcycle vehicle type
• car: Car vehicle type
• trailer: Trailer vehicle type
• bus: Bus vehicle type
• emergency: Emergency vehicle type
• goodsLess7_5T: Goods vehicle type with weight less than 7.5 tons
• goodsMore7_5T: Goods vehicle type with weight more than or equal to 7.5 tons
• busLess12: Bus vehicle type with less than 12 seats

fixedResourceId int64 nullable

The unique identifier of the resource who this vehicle is assigned to
Optional: Omit to retain current value or provide null to unset

reference string nullable

The internal reference of the vehicle - should usually be unique
Optional: Omit to retain current value or provide null to unset

registration string

The registration number of the vehicle
Optional: Omit to retain current value

make string nullable

The manufacturer of the vehicle
Optional: Omit to retain current value or provide null to unset

model string nullable

The model of the vehicle
Optional: Omit to retain current value or provide null to unset

registrationYear int32 nullable

The year that the vehicle was first registered as new
Optional: Omit to retain current value or provide null to unset

isSchedulable boolean

Indicates whether this vehicle can be scheduled jobs
Optional: Omit to retain current value

idlingFuelConsumptionRate double nullable

The litre fuel consumption of the vehicle used when idling per minute
Optional: Omit to retain current value or provide null to unset

costPerKm double nullable

The running cost of the vehicle per kilometre, expressed in costPerKmCurrencyCode
Optional: Omit to retain current value or provide null to unset

costPerDay double nullable

The running cost of the vehicle per day, expressed in costPerDayCurrencyCode
Optional: Omit to retain current value or provide null to unset

costPerKmCurrencyCode CurrencyWrite

Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd]

Currency definitions enum, matches currencies available in the BigChange Client Site

Possible values:

• eur: Euro
• aud: Australian Dollar
• gbp: Pound Sterling
• bgn: Bulgarian Lev
• cad: Canadian Dollar
• czk: Czech Koruna
• dkk: Danish Krone
• huf: Forint
• ils: New Israeli Sheqel
• lvl: Latvian Lats - replaced by Euro
• ltl: Lithuanian Litas - replaced by Euro
• mxn: Mexican Peso
• nzd: New Zealand Dollar
• nok: Norwegian Krone
• pln: Zloty
• ron: Romanian Leu
• rub: Russian Ruble
• zar: Rand
• sek: Swedish Krona
• chf: Swiss Franc
• aed: UAE Dirham
• usd: US Dollar

costPerDayCurrencyCode CurrencyWrite

Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd]

Currency definitions enum, matches currencies available in the BigChange Client Site

Possible values:

• eur: Euro
• aud: Australian Dollar
• gbp: Pound Sterling
• bgn: Bulgarian Lev
• cad: Canadian Dollar
• czk: Czech Koruna
• dkk: Danish Krone
• huf: Forint
• ils: New Israeli Sheqel
• lvl: Latvian Lats - replaced by Euro
• ltl: Lithuanian Litas - replaced by Euro
• mxn: Mexican Peso
• nzd: New Zealand Dollar
• nok: Norwegian Krone
• pln: Zloty
• ron: Romanian Leu
• rub: Russian Ruble
• zar: Rand
• sek: Swedish Krona
• chf: Swiss Franc
• aed: UAE Dirham
• usd: US Dollar

odometerUnit OdometerUnit

Possible values: [miles, kilometres]

The unit of measure for distance presented by the vehicles odometer

Possible values:

• miles
• kilometres

odometer int32

The latest reading from the vehicles odometer. If provided with a value, the new odometer reading will be recorded even if the value hasn't changed
Optional: Omit to retain current value

roadSafetyExpiresAt date nullable

The date of when the vehicles road safety test expires (eg. UK MOT test)
Optional: Omit to retain current value or provide null to unset

roadTaxExpiresAt date nullable

The date of when the vehicles road tax expires
Optional: Omit to retain current value or provide null to unset

serviceDueAt date nullable

The date of when the vehicles next service is due
Optional: Omit to retain current value or provide null to unset

insuranceDueAt date nullable

The date of when the vehicles insurance is due for renewal
Optional: Omit to retain current value or provide null to unset

co2EmissionsGramsPerKm int32 nullable

The vehicle co2 emission rate as (grams per km). Mutually exclusive with Co2EmissionsKilogramsPerLitre. Setting this property with a non-null value will nullify the Co2EmissionsKilogramsPerLitre property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre
Optional: Omit to retain current value or provide null to unset

co2EmissionsKilogramsPerLitre double nullable

The vehicle co2 emission rate as (kilograms per litre). Mutually exclusive with Co2EmissionsGramsPerKm. Setting this property with a non-null value will nullify the Co2EmissionsGramsPerKm property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre
Optional: Omit to retain current value or provide null to unset

customFields object[]
Custom fields associated with the vehicle. Omit or use an empty list to retain current values
Optional: Omit to retain current value
Array [
definitionId int64 required
The unique identifier of the associated custom field definition
value string nullable
The value of this custom field. If set to null, any existing value will be unset
]

Responses

• 204
• 400
• 403
• 404
• 422
• 500

---

No Content

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Not Found

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...