Create a condition check-in.

POST 
/api/vehicles/checkin/condition

Create a condition check-in. A mileage check-in requires 8 photos of the vehicle from various sides. 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 string

License plate number of the vehicle.

state string

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

photos

object[]

required

Array [

url stringrequired

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

type stringrequired

Possible values: Value must match regular expression ^(Back|Front|DriverSide|DriverSideFront|DriverSideBack|PassengerSide|PassengerSideFront|PassengerSideBack)$, [Back, Front, DriverSide, DriverSideFront, DriverSideBack, PassengerSide, PassengerSideFront, PassengerSideBack]

Type of the photo. A value from one of the condition checkin photo types.

]

Responses

200

The created condition check-in object.

application/json

Schema

Schema

id string

Id of the checkin

license string

License plate number

userNote string

User generated note. For communication between the user to the admin

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

updated string

Last updated on

photos

object[]

The photos of the vehicle taken from different angles

Array [

photoUrl string

URL of the photo

type string

Possible values: [Back, Front, DriverSide, DriverSideFront, DriverSideBack, PassengerSide, PassengerSideFront, PassengerSideBack]

Type of the photo. A value from one of the condition checkin photo types.

latitude double

Latitude at which photo was taken

longitude double

Longitude at which photo was taken

markedInvalidByReview boolean

Indicates that the photo has been marked invalid on review.

damageDetected boolean

Indicates that the review has detected damage to the vehicle.

]

fraud boolean

Example (from schema)

{
  "id": "string",
  "license": "string",
  "userNote": "string",
  "adminNote": "string",
  "checkedInAt": "string",
  "checkInStatus": "Confirmed",
  "updated": "string",
  "photos": [
    {
      "photoUrl": "string",
      "type": "Back",
      "latitude": 0,
      "longitude": 0,
      "markedInvalidByReview": true,
      "damageDetected": true
    }
  ],
  "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"
}

500

Possible error codes:

1. ERROR_INVALID_PHOTO_TYPE

2. ERROR_DUPLICATE_PHOTO_TYPE

3. ERROR_PHOTO_TYPE_MISSING

4. ERROR_INVALID_STATE_CODE

5. ERROR_PHOTO_NOT_OWNED_BY_USER

6. ERROR_CHECKIN_IS_LOCKED

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