Create a mileage check-in.

POST 
/api/vehicles/checkin/mileage

Create a mileage check-in. A mileage check-in requires an odometer reading and clear photos of the license plate and odometer. Photos need to be uploaded to the Ownli cloud via the Photo upload api.

Request

application/json

Body

required

vehicleId stringrequired

Vehicle Id of the vehicle.

licensePlate stringrequired

License plate number of the vehicle.

state string

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

mileage int32required

Current Mileage of vehicle. If this is not the first check-in the mileage will be validated against other check-ins and needs to equal or exceed those.

licensePhotos

object[]

required

Photos of the license plate. At this time only photo is supported

Array [

url stringrequired

Url of the photo. The photo needs to be uploaded via the Photo Upload API.

]

odometerPhotos

object[]

required

Photos of the odometer. At this time only photo is supported

Array [

url stringrequired

Url of the photo. The photo needs to be uploaded via the Photo Upload API.

]

Responses

200

The created mileage check-in object.

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

]

fraud boolean

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
    }
  ],
  "fraud": true
}

401

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

403

The caller does not have access to the vehicle or the vehicle is in a deactivated state. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

2. ERROR_VEHICLE_IS_NOT_ACTIVE_ON_POLICY

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"
}

409

Vehicle with same license plate exists. Possible error codes

1. ERROR_VEHICLE_ALREADY_EXISTS

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

Possible error codes:

1. ERROR_LICENSE_PHOTO_REQUIRED

2. ERROR_ODOMETER_PHOTO_REQUIRED

3. ERROR_MILEAGE_CHECKIN_SUPPORTS_ONLY_ONE_PHOTO

4. ERROR_LICENSE_PLATE_MISMATCH

5. ERROR_PHOTO_NOT_OWNED_BY_USER

6. ERROR_CHECKIN_IS_LOCKED

7. ERROR_MILEAGE

8. 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...