UpdateBooking 方法

注意：如要查看 UpdateBooking 的部分用途範例，請參閱本頁底部的 UpdateBooking 範例。

用戶端可使用 UpdateBooking 修改或取消現有的預訂。

如果因任何商業邏輯錯誤而導致預訂更新失敗，則應在 UpdateBookingResponse.booking_failure 欄位中填入該錯誤，並以 HTTP 狀態 200 傳回。

要求

UpdateBookingRequest

要求訊息的預訂欄位包含更新資訊。要求中會包含一個 booking_id，可供找出要更新的預訂；也包含下列項目之一：

1. 要更新的時段詳細資料 (預訂修改)
2. 要變更的狀態 (預訂取消)

要求中不會提供不需要變更的欄位。

傳回值

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;
}

UpdateBooking 範例

美容業範例的 UpdateBooking

要求

{
   "booking" : {
      "booking_id" : "890",
      "status" : "CANCELED"
   }
}

回應

{
   "booking" : {
      "booking_id" : "890",
      "status" : "CANCELED"
   }
}

健身範例的 UpdateBooking

要求

{
   "booking" : {
      "booking_id" : "890",
      "status" : "CANCELED"
   }
}

回應

{
   "booking" : {
      "booking_id" : "890",
      "status" : "CANCELED"
   }
}

更新金融服務範例的預訂

TODO