Get Vehicle Services

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/maintenance/services \
  --header 'Authorization: Bearer <token>'

{
  "services": [
    {
      "component": "VEHICLE",
      "type": "FULL_SERVICE",
      "kmToNextService": "<string>",
      "dateOfNextServiceAt": "2023-11-07T05:31:56Z",
      "dateOfLastServiceAt": "2023-11-07T05:31:56Z",
      "odometerKmAtLastService": "<string>",
      "status": "PENDING"
    }
  ]
}

Vehicle Services

Get Vehicle Services

Retrieves the list of services currently recommended for the vehicle.

This can include services for different components (e.g. brakes) but also statutory inspections (such as MOT in the UK or TÜV in Germany).

The service data may include the due date for the service, or the number of kilometers the vehicle can do before that particular service is due, or both. It may also include the date when the service was last performed.

Returns:

The list of services for the vehicle.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

AUTHENTICATION_ERROR
REQUEST_VALIDATION_ERROR
RESOURCE_NOT_FOUND
SERVER_ERROR

GET

vehicles

{vehicle_id}

maintenance

services

Get Vehicle Services

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/maintenance/services \
  --header 'Authorization: Bearer <token>'

{
  "services": [
    {
      "component": "VEHICLE",
      "type": "FULL_SERVICE",
      "kmToNextService": "<string>",
      "dateOfNextServiceAt": "2023-11-07T05:31:56Z",
      "dateOfLastServiceAt": "2023-11-07T05:31:56Z",
      "odometerKmAtLastService": "<string>",
      "status": "PENDING"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

vehicle_id

string

required

Unique internal identifier for the vehicle.

Response

200 - application/json

Successful Response

Service data for a vehicle and its components

services

VehicleService · object[]

required

Show child attributes

services.component

enum<string>

required

Component of the vehicle that requires service, for example BRAKE_FLUID. One of the options is VEHICLE, which means it is a full vehicle service.

Available options:

VEHICLE,

ENGINE,

TRANSMISSION,

DRIVE_TRAIN,

MOTOR,

BRAKES,

BRAKE_FRONT,

BRAKE_REAR,

BRAKE_FLUID,

STEERING,

SUSPENSION,

ELECTRIC_POWER_STEERING,

BATTERY,

AUXILIARY_BATTERY,

ELECTRICAL_SYSTEM,

HYBRID_SYSTEM,

ENGINE_OIL,

COOLING,

FUEL,

EXHAUST_SYSTEM,

EMISSIONS_SYSTEM,

TIRES,

TIRE_PRESSURE_MONITORING_SYSTEM,

AIRBAGS,

AIRBAG,

SEATBELTS,

CRASH_DETECTION_SYSTEM,

CRASH_SAFETY_SYSTEM,

AUTOMATIC_BRAKING_SYSTEM,

EMERGENCY_BRAKING_SYSTEM,

PEDESTRIAN_PROTECTION_SYSTEM,

LANE_DEPARTURE_WARNING_SYSTEM,

HILL_START_SYSTEM,

AUTOPILOT,

CRUISE_CONTROL,

PARKING_SENSORS,

CAMERAS,

SENSORS,

TRACTION_SYSTEM,

ELECTRONIC_STABILITY_CONTROL,

HEADLIGHTS,

SIDE_LIGHTS,

BRAKE_LIGHTS,

REAR_LIGHTS,

REVERSE_LIGHTS,

SIGNAL_LIGHTS,

NUMBER_PLATE_LIGHTS,

TRAILER_LIGHTS,

ADAPTIVE_LIGHTING_SYSTEM,

LIGHTS,

BODY,

DOORS,

TRUNK,

ROOF,

WINDOWS,

LOCKS,

KEYS,

SECURITY_SYSTEM,

WASHER_LIQUID,

WIPERS,

CLOCK,

ODOMETER,

EXTERNAL_CHARGING_EQUIPMENT,

VEHICLE_CHARGING_PORT,

CHARGING_COUPLER,

TRAILER

services.type

enum<string>

required

Type of service, for example FULL_SERVICE (a full, thorough check is required for the component) or HEALTH_CHECK (a quick check is required for the component)

Available options:

FULL_SERVICE,

HEALTH_CHECK,

STATUTORY,

OIL_CHANGE

services.kmToNextService

string | null

Vehicle kilometers until this service is due

services.dateOfNextServiceAt

string<date-time> | null

Date when this service is next due

services.dateOfLastServiceAt

string<date-time> | null

Date when this service was last performed

services.odometerKmAtLastService

string | null

Odometer reading when this service was last performed

services.status

enum<string>

Status of the service. Currently can only be PENDING (IE service is upcoming) or NO_SERVICE_DUE, but in future may be expanded to include when the service is in progress

Available options:

PENDING,

NO_SERVICE_DUE,

IN_SERVICE,

NOT_IN_SERVICE_UNKNOWN_IF_DUE

Bulk Vehicle Connect Vin Results Get Vehicle Tires Readings Historic

⌘I

Authentication

Accounts

Vehicles

Vehicle Telemetry

Vehicle Charging History

Vehicle Range

Vehicle State of Health

Vehicle Command Executions

Vehicle Alerts

Errors

Vehicle Connection

Vehicle Services

Vehicle Tires

Vehicle Manufacturer Alerts

Vehicle Eligibility

Rate Limit

Vehicle Charging Schedule

Vehicle Listening

Tags

Get Vehicle Services

Authorizations

Path Parameters

Response