Check In a Carpool Booking
POST/carpool/bookings/:booking_id/check-in
Records the vehicle of a booking in use as returned now. This operation is available to the main account only. The request has no body.
| Current status | Result |
|---|---|
ACTIVE, ACTIVE_ALMOST_LATE, ACTIVE_LATE, checked in at or before end_ts | The booking becomes RETURNED. |
ACTIVE, ACTIVE_ALMOST_LATE, ACTIVE_LATE, checked in after end_ts | The booking becomes RETURNED_LATE. |
| Active, but the vehicle ends its bookings on its own | 409 with CARPOOL_BOOKING_METHOD_CONFLICT. Nothing is changed. |
| Any other status | 409 with CARPOOL_BOOKING_STATE_CONFLICT. Nothing is changed. |
A vehicle ends its bookings on its own when its booking start and stop
method is the driver checklist, a geofence, MiKey, or key collection and
return. Those bookings end through that method. A method the account has
switched off does not count, so a vehicle linked only to a switched-off
method is checked in manually. Use
POST /carpool/bookings/{booking_id}/force-terminate to end one that is
stuck.
The driver who requested the booking is recorded as the one who returned the vehicle. No notification is sent.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 422
- 500
The checked in booking.
Unauthorized access. Authentication is required.
The operation requires main account credentials. Valid subusers receive this response.
The requested resource was not found.
The booking cannot take this step. Either its current status does not permit it, or its vehicle starts or ends bookings on its own through the vehicle's booking start and stop method. Nothing was changed.
Validation failed for the input parameters.
Internal server error.