Skip to content
Bottle

Read the mileage and date from vehicle paperwork

POST
/vehicles/{id}/documents/read
curl --request POST \
  --url https://example.com/vehicles/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/documents/read \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "data": "example", "expectedKind": "service" }'

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
data
required
string
<= 7500000 characters /^data:(application\/pdf|image\/(jpeg|png));base64,[\d+/A-Za-z]+={0,2}$/
expectedKind
string
Allowed values: service

Responses

Section titled “Responses”

200

Section titled “200”

Values Bottle could read, or an unavailable result

Media typeapplication/json
object
read
required
boolean
kind
required
string | null
Allowed values: mot insurance registration service lease inspection other
mileage
required
integer | null
documentDate
required
string | null format: date
service
required
object
title
required
string
>= 1 characters <= 160 characters
performedOn
required
string | null format: date
mileage
required
integer | null
<= 10000000
costPence
required
integer | null
<= 100000000
provider
required
string | null
<= 160 characters
notes
required
string | null
<= 2000 characters
nextDueOn
required
string | null format: date
nextDueMileage
required
integer | null
<= 10000000
lineItems
required
Array<object>
<= 40 items
object
description
required
string
>= 1 characters <= 240 characters
quantity
required
number | null
> 0 <= 1000
amountPence
required
integer | null
<= 100000000

Example 

{
  "kind": "mot"
}

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