UpdateBooking-Methode

Der Client verwendet "UpdateBooking", um eine vorhandene Buchung zu ändern oder zu stornieren.

Wenn die Aktualisierung einer Buchung aufgrund eines Fehlers in der Geschäftslogik fehlschlägt, sollte der Fehler im Feld UpdateBookingResponse.booking_failure ausgefüllt und zurückgegeben mit dem HTTP-Status 200.

Anfrage

UpdateBookingRequest

Eine Anfragenachricht enthält aktualisierte Informationen im Buchungsfeld. Die Anfrage enthält eine booking_id zur Identifizierung der zu aktualisierenden Buchung. Es enthält außerdem eines der folgenden Elemente:

1. Details für den Slot, der geändert werden soll (Änderungen der Buchung)
2. Status, der geändert werden soll (Stornierung der Buchung)

Felder, die nicht geändert werden müssen, sind in der Anfrage nicht enthalten.

Rückgabewert

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-Beispiele

UpdateBooking für Beauty-Beispiele

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

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

UpdateBooking für Fitness-Samples

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

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

Beispiele für „UpdateBooking“ für Finanzdienstleistungen

Aufgaben