Skip to content
Bottle

Get a vehicle's operational record

GET
/vehicles/{id}/record
curl --request GET \
  --url https://example.com/vehicles/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/record \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

The vehicle record

Media typeapplication/json
object
vehicle
required
object
id
required

UUID v7

string format: uuid
name
required
string
>= 1 characters <= 80 characters
registration
required
string | null
<= 16 characters
kind
required
string
Allowed values: small_van large_van pickup box_truck flatbed other
make
required
string | null
model
required
string | null
year
required
integer | null
>= 1900 <= 2200
odometerMiles
required
integer | null
odometerRecordedOn
required
string | null format: date
odometerUpdatedAt
required
string | null format: date-time
startLocationId
required

UUID v7

string | null format: uuid
endLocationId
required

UUID v7

string | null format: uuid
yardId
required

UUID v7

string | null format: uuid
areas
required
Array<string>
payloadKg
required
integer | null
volumeLitres
required
integer | null
notes
required
string | null
motDueOn
required
string | null format: date
taxDueOn
required
string | null format: date
servicedOn
required
string | null format: date
serviceDueOn
required
string | null format: date
archivedAt
required
string | null format: date-time
usualDriverUserId
required
string | null
usualDriverName
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
metrics
required
object
roundsCompleted
required
integer
deliveriesCompleted
required
integer
daysUsed
required
integer
distanceMetres
required
integer
stockOnVehicle
required
object
fullCylinders
required
integer
emptyCylinders
required
integer
currentRound
required
object
id
required

UUID v7

string format: uuid
roundDate
required
string format: date
status
required
string
Allowed values: planned out done
driverName
required
string | null
issuedAt
required
string | null format: date-time
startLocationId
required

UUID v7

string | null format: uuid
yardId
required

UUID v7

string | null format: uuid
stops
required
integer
completedStops
required
integer
distanceMetres
required
integer | null
loadKg
required
number | null
loadLitres
required
integer | null
van
required
object
latitude
required
number
longitude
required
number
seenAt
required
string format: date-time
previewStops
required
Array<object>
object
id
required

UUID v7

string format: uuid
orderId
required

UUID v7

string format: uuid
sequence
required
integer
> 0
latitude
required
number | null
longitude
required
number | null
customerName
required
string | null
deliverTo
required
string | null
summary
required
string
etaAt
required
string | null
completedAt
required
string | null format: date-time
failedAt
required
string | null format: date-time
recentRounds
required
Array<object>
object
id
required

UUID v7

string format: uuid
roundDate
required
string format: date
status
required
string
Allowed values: planned out done
driverName
required
string | null
issuedAt
required
string | null format: date-time
startLocationId
required

UUID v7

string | null format: uuid
yardId
required

UUID v7

string | null format: uuid
stops
required
integer
completedStops
required
integer
distanceMetres
required
integer | null
loadKg
required
number | null
loadLitres
required
integer | null
van
required
object
latitude
required
number
longitude
required
number
seenAt
required
string format: date-time
previewStops
required
Array<object>
object
id
required

UUID v7

string format: uuid
orderId
required

UUID v7

string format: uuid
sequence
required
integer
> 0
latitude
required
number | null
longitude
required
number | null
customerName
required
string | null
deliverTo
required
string | null
summary
required
string
etaAt
required
string | null
completedAt
required
string | null format: date-time
failedAt
required
string | null format: date-time
maintenance
required
Array<object>
object
id
required

UUID v7

string format: uuid
vehicleId
required

UUID v7

string format: uuid
kind
required
string
Allowed values: service mot repair inspection tyres oil other
title
required
string
performedOn
required
string format: date
mileage
required
integer | null
costPence
required
integer | null
provider
required
string | null
notes
required
string | null
nextDueOn
required
string | null format: date
nextDueMileage
required
integer | null
lineItems
required
Array<object>
object
description
required
string
>= 1 characters <= 240 characters
quantity
required
number | null
> 0 <= 1000
amountPence
required
integer | null
<= 100000000
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
documents
required
Array<object>
object
id
required

UUID v7

string format: uuid
vehicleId
required

UUID v7

string format: uuid
kind
required
string
Allowed values: mot insurance registration service lease inspection other
name
required
string
contentType
required
string
Allowed values: application/pdf image/jpeg image/png
byteSize
required
integer
documentDate
required
string | null format: date
mileage
required
integer | null
mileageAppliedAt
required
string | null format: date-time
expiresOn
required
string | null format: date
createdAt
required
string format: date-time
url
required
string

Example 

{
  "vehicle": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "name": "Van 1",
    "registration": "KT65 ABC",
    "kind": "small_van",
    "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "payloadKg": 1200,
    "volumeLitres": 10000
  },
  "currentRound": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "status": "planned",
    "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "previewStops": [
      {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      }
    ]
  },
  "recentRounds": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "status": "planned",
      "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "previewStops": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ],
  "maintenance": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "vehicleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "kind": "service"
    }
  ],
  "documents": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "vehicleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "kind": "mot",
      "contentType": "application/pdf"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

No such vehicle or record

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}