Skip to main content

List all mileage check-ins.

GET 
/api/checkins/mileage

Retrieve the list of mileage check-ins of all users owned by a partner.

Request​

Query Parameters

    page int32

    Default value: 0

    Page number

    Example: 0
    size int32

    Default value: 10

    Number of items per page

    Example: 10
    sortBy string

    Possible values: [dateCheckedIn, dateUpdated]

    Default value: dateCheckedIn

    Sort by field

    Example: dateCheckedIn
    sortDirection string

    Possible values: [asc, desc]

    Default value: desc

    Sort by order

    Example: desc
    searchBy string

    Possible values: [license, vin, state, userFirstName, userLastName, userEmail, userPhone]

    Search by field

    Example: userFirstName
    searchValue string

    Search by value

    Example: Tom
    status string

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

    Filter mileage check-ins by status

    Example: Pending
    vehicleId string

    Filter mileage check-ins by vehicle id

    Example: XT_IVEHABC123
    checkinStartDate string

    Filter mileage check-ins whose check-in date is greater or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z
    checkinEndDate string

    Filter mileage check-ins whose check-in date is less or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z
    updatedStartDate string

    Filter mileage check-ins whose update date is greater or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z
    updatedEndDate string

    Filter mileage check-ins whose update date is less or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z

Header Parameters

    partnerId stringrequired

    Partner Id

    clientId stringrequired

    Client Id

    clientSecret stringrequired

    Client Secret

Responses​

List of Mileage checkin objects matching given query.

Schema

    totalItems int64

    Total number of mileage check-ins

    currentPage int32

    Current page number

    totalPages int64

    Current page size

    itemsOnPage int32

    Number of mileage check-ins on current page

    checkins

    object[]

    List of mileage check-ins

  • Array [

    • 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

  • ]

    • vehicle

    object

    Check-in vehicle

    id string

    Id of the vehicle

    license string

    License plate number

    photoUrl string

    Photo of Vehicle

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

    owner

    object

    Check-in owner

    id string

    Id of the user

    firstName string

    User's first name

    lastName string

    User's last name

  • ]

Loading...