Retrieve a mileage check-in.

GET 
/api/vehicles/checkin/mileage/:id

Retrieve a mileage check-in for a vehicle.

Request

Path Parameters

id stringrequired

The id of the checkin

Header Parameters

partnerId stringrequired

Partner Id

clientId stringrequired

Client Id

clientSecret stringrequired

Client Secret

Responses

200

The mileage check-in object requested.

application/json

Schema

Schema

id string

Id of the checkin

license string

License plate number

adminNote string

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

checkedInAt string

Check-in date

checkInStatus string

Possible values: [Confirmed, Declined, OnHold, Pending]

Status of the check-in

mileage int32

Mileage at time of check-in

nextCheckInDate string

A indicative time for the next check-in. If the check-ins are allowed at a specific cadence this value will carry the next recommended check-in date. When more complex rules are allowed this field should not be used.

updated string

Last updated on

licensePhotos

object[]

The photo of the license plate

Array [

photoUrl string

URL of the photo

latitude double

Latitude at which photo was taken

longitude double

Longitude at which photo was taken

]

odometerPhotos

object[]

The photo of the odometer

Array [

photoUrl string

URL of the photo

latitude double

Latitude at which photo was taken

longitude double

Longitude at which photo was taken

]

Example (from schema)

{
  "id": "string",
  "license": "string",
  "adminNote": "string",
  "checkedInAt": "string",
  "checkInStatus": "Confirmed",
  "mileage": 0,
  "nextCheckInDate": "string",
  "updated": "string",
  "licensePhotos": [
    {
      "photoUrl": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "odometerPhotos": [
    {
      "photoUrl": "string",
      "latitude": 0,
      "longitude": 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

Check-in not found or Vehicle not found or owning User not found. Possible error codes

1. ERROR_USER_NOT_FOUND

2. ERROR_VEHICLE_NOT_FOUND

3. ERROR_MILEAGE_CHECKIN_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...