Service Signals

IsInService

GET /vehicles/{vehicleId}/signals/service-isinservice

A boolean that Indicates if the vehicle is currently in service

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

Records

GET /vehicles/{vehicleId}/signals/service-records

An array containing records of service that has been performed on the vehicle.

body · object

Show body properties

values · array · required

An array of service records.

Show Array item properties

id · string

A unique identifier for the service record.

cost · object

The monetary amount billed by the service provider for the service.

Show cost properties

amount · number

The numerical portion of the amount.

currency · string

The currency for the amount.

time · string

The timestamp of when the service occurred.

tasks · array

An array containing information about tasks performed as part of the service.

Show Array item properties

id · string

A unique identifier for the task.

description · string

A description of the task that was performed.

details · array

An array containing additional details about the service.

Show Array item properties

id · string

A unique identifier for the additional detail item.

description · string

A text string describing the additional detail item.

odometer · number

The vehicle’s odometer at the time of the service.

Example

{
  "values": [
    {
      "id": "SVC-20230427-001",
      "time": 1682591400000,
      "odometer": 45231,
      "tasks": [
        {
          "id": "task-001",
          "description": "Oil change"
        }
      ],
      "details": [
        {
          "id": "detail-001",
          "description": "Used synthetic oil"
        }
      ],
      "cost": {
        "currency": "USD",
        "amount": 349.95
      }
    }
  ]
}