Check Carpool Vehicle Availability
GET/carpool/vehicles/availability
Asks Carpool whether a booking would be accepted for a vehicle and window,
before POST /carpool/bookings is called. Supply exactly one of
filter[vehicle_id] and filter[category_id].
The window, vehicle and driver go through the checks POST /carpool/bookings
applies, including the account cooldown between bookings. A category
selection returns the one vehicle Carpool would assign and needs
filter[request_driver_id]. A vehicle selection may leave the driver out,
and then only the window and vehicle checks run. A 422 carries the
reason_code POST /carpool/bookings returns for the same cause.
The Checking Availability guide covers the checks and their order, what only create checks, and what a subuser sees.
Request
Responses
- 200
- 401
- 403
- 409
- 422
- 429
- 500
- 503
The bookable vehicle, or an empty list when the vehicle is not an active Carpool vehicle of the account. The list holds at most one item, so the response carries no pagination.
Unauthorized access. Authentication is required.
Access is forbidden. The user does not have permission to access this resource, or the account is not currently active.
The supplied driver already holds an overlapping booking (CARPOOL_DRIVER_SCHEDULE_CONFLICT), the same refusal POST /carpool/bookings returns.
Request field validation or Carpool business validation failed.
Too Many Requests - the endpoint's rate limit has been exceeded. Retry after the number of seconds in the Retry-After header.
Response Headers
Seconds to wait before retrying. The same value as X-RateLimit-Retry-After-Seconds when that wait is non-negative. If the computed wait is negative, Retry-After is floored at 0.
Unix timestamp of the next earliest successful request.
Seconds until the next earliest successful request.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.