latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Vehicles

Get a vehicle

Retrieve the details of a single vehicle (required scope vehicles:read)

get/v1/vehicles/{vehicleId}

Path parameters

vehicleIdinteger required

The unique identifer of the vehicle

Headers

Customer-Idinteger required

The customer identifier

Response

idinteger

The unique identifier of the vehicle

createdAtstring date-time

The UTC timestamp of when this vehicle was created

groupIdinteger

The unique identifier of the group that the vehicle belongs to

Enumeration representing different types of vehiclesPossible values:<ul><li>motorcycle: Motorcycle vehicle type</li><li>car: Car vehicle type</li><li>trailer: Trailer vehicle type</li><li>bus: Bus vehicle type</li><li>emergency: Emergency vehicle type</li><li>goodsLess7_5T: Goods vehicle type with weight less than 7.5 tons</li><li>goodsMore7_5T: Goods vehicle type with weight more than or equal to 7.5 tons</li><li>busLess12: Bus vehicle type with less than 12 seats</li></ul>

fixedResourceIdinteger nullable

The unique identifier of the resource who this vehicle is assigned to

groupNamestring

The name of the group that the vehicle belongs to

referencestring

The internal reference of the vehicle - should usually be unique

registrationstring

The registration number of the vehicle

makestring nullable

The manufacturer of the vehicle

modelstring nullable

The model of the vehicle

registrationYearinteger nullable

The year that the vehicle was first registered as new

isSchedulableboolean

Indicates whether this vehicle can be scheduled jobs

idlingFuelConsumptionRatenumber double nullable

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

costPerKmnumber double nullable

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

costPerDaynumber double nullable

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

costPerKmCurrencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN'

CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the databasePossible values:<ul><li>EUR: Euro</li><li>AUD: Australian Dollar</li><li>GBP: Pound Sterling</li><li>BGN: Bulgarian Lev</li><li>CAD: Canadian Dollar</li><li>CZK: Czech Koruna</li><li>DKK: Danish Krone</li><li>HUF: Forint</li><li>ILS: New Israeli Sheqel</li><li>LVL: Latvian Lats - replaced by Euro</li><li>LTL: Lithuanian Litas - replaced by Euro</li><li>MXN: Mexican Peso</li><li>NZD: New Zealand Dollar</li><li>NOK: Norwegian Krone</li><li>PLN: Zloty</li><li>RON: Romanian Leu</li><li>RUB: Russian Ruble</li><li>ZAR: Rand</li><li>SEK: Swedish Krona</li><li>CHF: Swiss Franc</li><li>AED: UAE Dirham</li><li>USD: US Dollar</li><li>UNKNOWN: Unknown currency</li></ul>

costPerDayCurrencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN'

odometerUnit'miles' | 'kilometres'

The unit of measure for distance presented by the vehicles odometerPossible values:<ul><li>miles</li><li>kilometres</li></ul>

odometerEstimateinteger nullable

An estimate of vehicle odometer reading, based on tracked distance

odometerinteger nullable

The latest reading from the vehicles odometer

odometerReadAtstring date-time nullable

The UTC timestamp of when the odometer reading was last recorded

roadSafetyExpiresAtstring date nullable

The date of when the vehicle's road safety test expires (eg. UK MOT test)

roadTaxExpiresAtstring date nullable

The date of when the vehicle's road tax expires

serviceDueAtstring date nullable

The date of when the vehicle's next service is due

insuranceDueAtstring date nullable

The date of when the vehicle's insurance is due for renewal

co2EmissionsGramsPerKminteger nullable

The vehicle co2 emission rate as (grams per km)

co2EmissionsKilogramsPerLitrenumber double nullable

The vehicle co2 emission rate as (kilograms per litre)

Example response

{
  "id": 5514123,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "groupId": 1211,
  "vehicleType": "motorcycle",
  "fixedResourceId": 1211,
  "groupName": "Vans",
  "reference": "ABC5514123",
  "registration": "BC24 BIG",
  "make": "Ford",
  "model": "Transit",
  "registrationYear": 2012,
  "isSchedulable": true,
  "idlingFuelConsumptionRate": 0.1,
  "costPerKm": 0.25,
  "costPerDay": 0.25,
  "costPerKmCurrencyCode": "EUR",
  "costPerDayCurrencyCode": "EUR",
  "odometerUnit": "miles",
  "odometerEstimate": 510200,
  "odometer": 51023,
  "odometerReadAt": "2022-11-29T16:50:16.0000000+00:00",
  "roadSafetyExpiresAt": "2022-11-29",
  "roadTaxExpiresAt": "2022-11-29",
  "serviceDueAt": "2022-11-29",
  "insuranceDueAt": "2022-11-29",
  "co2EmissionsGramsPerKm": 5,
  "co2EmissionsKilogramsPerLitre": 5.5,
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}