Odometer registrations

Odometer registrations on a vehicle.

Odometer registration

Odometer registration for vehicle on ticket.

id	string <uuid> Identifier of odometer registration.
created_at	string <date-time> Date and time of creation.
is_breaking	boolean Whether this registration is breaking the trend of increasing registrations, meaning its value is lower then the previous registration for the same VIN.
value	number <float> [ 1 .. 1000000000 ] Odometer registration in kilometers.
vin	string = 17 characters Vehicle Identification Number (VIN) of the vehicle for this odometer registration.

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-03-15T08:12:28Z",
"is_breaking": true,
"value": 182432.42,
"vin": "JH4KA7630PC007649"
}

Retrieve odometer registrations [BETA]

Retrieve a list of odometer registrations for a vehicle.

SecurityOAuth2 and ApiKey

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.
	object Default: {"created_at":"asc"} Sort odometer registrations. Example: sort_by[created_at]=asc
vin required	string = 17 characters Vehicle Identification Number (VIN) to get odometer registrations for. Example: vin=JH4KA7630PC007649

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
	object Default: {"created_at":"asc"} The applied value of the sort_by query parameter on the resources in result.
property name* additional property	any

Array of objects (Odometer registration) >= 0 items

List of odometer registrations for given vin sorted by created_at descending.

Array (>= 0 items)

id	string <uuid> Identifier of odometer registration.
created_at	string <date-time> Date and time of creation.
is_breaking	boolean Whether this registration is breaking the trend of increasing registrations, meaning its value is lower then the previous registration for the same VIN.
value	number <float> [ 1 .. 1000000000 ] Odometer registration in kilometers.
vin	string = 17 characters Vehicle Identification Number (VIN) of the vehicle for this odometer registration.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/odometer-registrations

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0,
"sort_by": {"created_at": "asc"
}
},
"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-03-15T08:12:28Z",
"is_breaking": true,
"value": 182432.42,
"vin": "JH4KA7630PC007649"
}
],
"total": 3255
}

Add odometer registration [BETA]

Add a new odometer registration for a vehicle.

SecurityApiKey and OAuth2

Request

Request Body schema: application/json

The odometer registration you wish to add.

value required	number <float> [ 1 .. 1000000000 ] Odometer registration in kilometers.
vin required	string = 17 characters Vehicle Identification Number (VIN) of the vehicle for this odometer registration.
ticket_id required	string <uuid> Identifier of the ticket.

Responses

201

Created.

Response Schema: application/json

id	string <uuid> Identifier of odometer registration.
created_at	string <date-time> Date and time of creation.
is_breaking	boolean Whether this registration is breaking the trend of increasing registrations, meaning its value is lower then the previous registration for the same VIN.
value	number <float> [ 1 .. 1000000000 ] Odometer registration in kilometers.
vin	string = 17 characters Vehicle Identification Number (VIN) of the vehicle for this odometer registration.

default

An error occurred - see status code and problem response for more information.

post/v2/vehicles/odometer-registrations

Request samples

Payload

application/json

{"value": 182432.42,
"vin": "JH4KA7630PC007649",
"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8"
}

Response samples

201
default

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-03-15T08:12:28Z",
"is_breaking": true,
"value": 182432.42,
"vin": "JH4KA7630PC007649"
}

Retrieve odometer registration [BETA]

Retrieve single odometer registration for a vehicle by identifier.

SecurityOAuth2 and ApiKey

Request

path Parameters

odometer-registration-id

required

string <uuid>

Identifier of the odometer registration.

Responses

200

Successful response.

Response Schema: application/json

id	string <uuid> Identifier of odometer registration.
created_at	string <date-time> Date and time of creation.
is_breaking	boolean Whether this registration is breaking the trend of increasing registrations, meaning its value is lower then the previous registration for the same VIN.
value	number <float> [ 1 .. 1000000000 ] Odometer registration in kilometers.
vin	string = 17 characters Vehicle Identification Number (VIN) of the vehicle for this odometer registration.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/odometer-registrations/{odometer-registration-id}

Response samples

200
default

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-03-15T08:12:28Z",
"is_breaking": true,
"value": 182432.42,
"vin": "JH4KA7630PC007649"
}

➔ Next to Makes