Retrieve a summary of all check-ins for a vehicle

GET 
/api/vehicles/:vehicleId/checkin-summary

Retrieve a summary of all check-ins for a vehicle. This includes mileage, condition and service check-ins.

Request

Path Parameters

vehicleId stringrequired

Header Parameters

partnerId stringrequired

Partner Id

clientId stringrequired

Client Id

clientSecret stringrequired

Client Secret

Responses

200

A summary of check-in information about the vehicle.

application/json

Schema

Schema

• Array [

id string

Id of the vehicle

license string

License plate number

make string

Make of the vehicle

model string

Model of the vehicle

vin string

VIN of the vehicle.

state string

2 Letter State Code (eg. AL, CA, CO etc.)

mileageCheckinSummary

object

A summary of mileage check-ins for a vehicle.

checkins

object[]

List of all check-ins

Array [

id string

Id of the check-in

checkInType string

Type of the check-in

status string

Status of the check-in

checkinDate string

Timestamp of the check-in

adminNote string

Admin generated note. Usually used for on-hold or declined check-ins

reward

object

Reward associated with the check-in

id string

Id of the reward

status string

Possible values: [Pending, Confirmed, Declined, Claimed, All]

Status of the reward

dateRewarded string

Date on which reward was created

amount double

]

checkinUnlocked boolean

Is a check-in unlocked.

unlockDate string

If the check-in is unlocked, the time at which it was unlocked.

daysToNextCheckin int64

Number of days to next check-in.

rewardAmountForNextCheckin double

Reward for next check-in based on current campaign setup.

lastConfirmedOrdinal int32

The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

lastConfirmedMileage int64

Mileage of last confirmed check-in.

conditionCheckinSummary

object

A summary of condition check-ins for a vehicle.

checkins

object[]

List of all check-ins

Array [

id string

Id of the check-in

checkInType string

Type of the check-in

status string

Status of the check-in

checkinDate string

Timestamp of the check-in

adminNote string

Admin generated note. Usually used for on-hold or declined check-ins

reward

object

Reward associated with the check-in

id string

Id of the reward

status string

Possible values: [Pending, Confirmed, Declined, Claimed, All]

Status of the reward

dateRewarded string

Date on which reward was created

amount double

]

checkinUnlocked boolean

Is a check-in unlocked.

unlockDate string

If the check-in is unlocked, the time at which it was unlocked.

daysToNextCheckin int64

Number of days to next check-in.

rewardAmountForNextCheckin double

Reward for next check-in based on current campaign setup.

lastConfirmedOrdinal int32

The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

• ]

Example (from schema)

[
  {
    "id": "string",
    "license": "string",
    "make": "string",
    "model": "string",
    "vin": "string",
    "state": "string",
    "mileageCheckinSummary": {
      "checkins": [
        {
          "id": "string",
          "checkInType": "string",
          "status": "string",
          "checkinDate": "string",
          "adminNote": "string",
          "reward": {
            "id": "string",
            "status": "Pending",
            "dateRewarded": "string",
            "amount": 0
          }
        }
      ],
      "checkinUnlocked": true,
      "unlockDate": "string",
      "daysToNextCheckin": 0,
      "rewardAmountForNextCheckin": 0,
      "lastConfirmedOrdinal": 0,
      "lastConfirmedMileage": 0
    },
    "conditionCheckinSummary": {
      "checkins": [
        {
          "id": "string",
          "checkInType": "string",
          "status": "string",
          "checkinDate": "string",
          "adminNote": "string",
          "reward": {
            "id": "string",
            "status": "Pending",
            "dateRewarded": "string",
            "amount": 0
          }
        }
      ],
      "checkinUnlocked": true,
      "unlockDate": "string",
      "daysToNextCheckin": 0,
      "rewardAmountForNextCheckin": 0,
      "lastConfirmedOrdinal": 0
    }
  }
]

401

Authorization error e.g. due to an invalid or missing API keys.

403

Forbidden. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

404

Vehicle not found or owning User not found. Possible error codes

1. ERROR_USER_NOT_FOUND

2. ERROR_VEHICLE_NOT_FOUND

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

Internal error. Possible error codes

1. INTERNAL_SERVER_ERROR

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...