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

更新了金融服务示例中的 UpdateBooking

待办