روش UpdateBooking

مشتری از UpdateBooking برای تغییر یا لغو رزرو موجود استفاده می کند.

اگر به‌دلیل هرگونه خطای منطق تجاری، به‌روزرسانی رزرو انجام نشد، این خطا باید در پاسخ تکمیل شود. برای اطلاعات دقیق، به شکست رزرو مراجعه کنید.

درخواست

UpdateBooking Request

یک پیام درخواست حاوی اطلاعات به روز شده در قسمت رزرو است و مسیرهای تمام فیلدهای رزرو را برای به روز رسانی در قسمت update_mask فهرست می کند. به عنوان مثال، فیلد update_mask درخواستی که یک رزرو موجود را مجدداً برنامه ریزی می کند شامل دو مسیر زیر است:

  paths: "slot.start_time"
  paths: "slot.duration"

برای اطلاعات بیشتر به FieldMask مراجعه کنید.

ارزش برگشتی

UpdateBookingResponse

کدهای خطای متعارف gRPC

• INVALID_ARGUMENT (اگر فیلد ماسک ارائه شده حاوی مقادیر نامعتبر باشد یا هر یک از فیلدهای رزرو به روز شده نامعتبر باشد)
• NOT_FOUND (اگر شناسه رزرو ارائه شده برای شریک ناشناخته باشد)

// Request to update a [ext.maps.booking.partner.v2.Booking]
message UpdateBookingRequest {
  // Field mask of all booking fields to be updated (optional)
  google.protobuf.FieldMask update_mask = 1;

  // 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 = 2;
}

// Response with the updated [ext.maps.booking.partner.v2.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;
}