הלקוח משתמש ב-UpdateBooking כדי לשנות או לבטל הזמנה קיימת.
אם העדכון של ההזמנה נכשל בגלל שגיאה בלוגיקה העסקית, צריך לאכלס את השגיאה בשדה UpdateBookingResponse.booking_failure
ולהחזיר אותה עם סטטוס HTTP 200.
בקשה
UpdateBookingRequest
הודעת הבקשה מכילה מידע מעודכן בשדה ההזמנה.
הבקשה תכלול את השדה booking_id
כדי לזהות את ההזמנה שרוצים לעדכן. הוא יכלול גם אחת מהאפשרויות הבאות:
- פרטי המשבצת לעדכון (שינויים בהזמנה)
- הסטטוס שרוצים לשנות (ביטול הזמנה)
שדות שלא דורשים שינוי לא יפורטו בבקשה.
ערך המוחזר
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 לדוגמאות של Fitness
בקשה
{ "booking" : { "booking_id" : "890", "status" : "CANCELED" } }
תשובה
{ "booking" : { "booking_id" : "890", "status" : "CANCELED" } }
עדכון של UpdateBooking לדוגמאות של שירותים פיננסיים
TODO