روش UpdateBooking

درخواست

UpdateBooking Request

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

  paths: "start_time"
  paths: "duration"

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

ارزش برگشتی

UpdateBookingResponse

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

• اگر فیلد ماسک ارائه شده حاوی مقادیر نامعتبر باشد یا هر یک از فیلدهای رزرو به روز شده نامعتبر باشد، INVALID_ARGUMENT . این شامل مواردی می‌شود که به‌روزرسانی فیلد توسط منطق تجاری مجاز نیست، مثلاً به دلیل اینکه برای لغو خیلی دیر شده است.
• اگر شناسه رزرو ارائه شده ناشناخته باشد، NOT_FOUND
• RESOURCE_EXHAUSTED اگر شکافی که با زمان شروع به روز شده مطابقت دارد برای رزرو موجود نباشد.

// Request to update a [ext.maps.booking.partner.v0.Booking]
message UpdateBookingRequest {
  // Field mask of all booking fields to be updated
  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.
  // - start_time and duration to reschedule a booking.
  Booking booking = 2;
}

// Response with the updated [ext.maps.booking.partner.v0.Booking]
message UpdateBookingResponse {
  // The updated booking
  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.
  UserPaymentOption user_payment_option = 2;
}