Create a vehicle

Create a new vehicle (required scope vehicles:write)

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body required

groupId int64 required

The unique identifier of the group that the vehicle belongs to

vehicleType VehicleType required

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

reference string nullable

The internal reference of the vehicle - should usually be unique

registration string required

Possible values: non-empty

The registration number of the vehicle

make string nullable

The manufacturer of the vehicle

model string nullable

The model of the vehicle

registrationYear int32 nullable

The year that the vehicle was first registered as new

isSchedulable boolean

Indicates whether this vehicle can be scheduled jobs

idlingFuelConsumptionRate double nullable

The litre fuel consumption of the vehicle used when idling per minute

costPerKm double nullable

The running cost of the vehicle per kilometre, expressed in costPerKmCurrencyCode

costPerDay double nullable

The running cost of the vehicle per day, expressed in costPerDayCurrencyCode

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 nullable

The latest reading from the vehicles odometer

roadSafetyExpiresAt date nullable

The date of when the vehicles road safety test expires (eg. UK MOT test)

roadTaxExpiresAt date nullable

The date of when the vehicles road tax expires

serviceDueAt date nullable

The date of when the vehicles next service is due

insuranceDueAt date nullable

The date of when the vehicles insurance is due for renewal

co2EmissionsGramsPerKm int32 nullable

The vehicle co2 emission rate as (grams per km). Mutually exclusive with Co2EmissionsKilogramsPerLitre

co2EmissionsKilogramsPerLitre double nullable

The vehicle co2 emission rate as (kilograms per litre). Mutually exclusive with Co2EmissionsGramsPerKm

customFields object[] nullable

Custom fields associated with the vehicle

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

Created

application/json

Schema

Example (from schema)

Schema

id int64

Identifier of the newly created record

{
  "id": 0
}

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"
}

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"
}

Create a vehicle​

Create a vehicle