ListBookings method

  • The ListBookingsRequest is used to request future bookings for a specific user.

  • The request requires a user_id.

  • The ListBookingsResponse returns a list of Booking objects for the requested user.

  • A NOT_FOUND error occurs if the user ID is unknown to the partner.

Request

ListBookingsRequest

Return value

ListBookingsResponse

This only needs to return future bookings for a user, not bookings for all time.

Canonical gRPC error codes

  • NOT_FOUND (if the requested user ID is unknown to the partner)
// Request to list all upcoming bookings for a user
message ListBookingsRequest {
  // ID of the user (required)
  string user_id = 1;
}

// Response for the [ext.maps.booking.partner.v2.ListBookings] RPC with all
// upcoming bookings for the requested user
message ListBookingsResponse {
  // All bookings of the user (required)
  repeated Booking bookings = 1;
}