Méthode UpdateBooking

Le client utilise UpdateBooking pour modifier ou annuler une réservation existante.

Si la mise à jour d'une réservation échoue en raison d'une erreur de logique métier, celle-ci doit être insérée dans le champ UpdateBookingResponse.booking_failure et renvoyée avec l'état HTTP 200.

Requête

UpdateBookingRequest

Le message d'une requête contient des informations mises à jour dans le champ de réservation. La requête contient un booking_id permettant d'identifier la réservation à mettre à jour. Elle comprend également l'un des éléments suivants:

  1. Informations sur le créneau à mettre à jour (modifications de la réservation)
  2. État à modifier (annulation de la réservation)

Les champs qui ne nécessitent pas de modification ne sont pas fournis dans la requête.

Valeur renvoyée :

UpdateBookingResponse

// Request to update a Booking.
message UpdateBookingRequest {
  // The booking to be updated
  // The following fields can be set in a booking:
  // - status, to cancel a booking.
  // - one of the following is required:
  //   - start_time AND duration in the slot, to reschedule a booking.
  //   - party_size (for dining reservations).
  Booking booking = 1;
}

// Response with the updated Booking.
message UpdateBookingResponse {
  // The updated booking (required)
  Booking booking = 1;

  // The updated user payment option originally used to pay for this booking.
  // This should be set if the UpdateBookingRequest results in a change to
  // the UserPaymentOption.
  // For instance, if the booking is canceled, the UserPaymentOption should
  // reflect an additional credit to the user. In the case of a multi-use
  // payment option, the current_count should be increased by one to
  // allow the user to create another booking with this payment option. In the
  // case of a single-use payment option, a new single-use user payment option
  // should be returned. (required if altered in update)
  UserPaymentOption user_payment_option = 2;

  // If updating a booking fails, this field should reflect the business logic
  // error (e.g., booking is not cancellable) (required if failure occurs)
  BookingFailure booking_failure = 3;
}