UpdateBooking-Methode

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

Kann eine Buchung aufgrund eines Fehlers in der Geschäftslogik nicht aktualisiert werden, sollte der Fehler in der Antwort zurückgegeben werden. Weitere Informationen findest du hier.

Anfrage

UpdateBookingRequest

Eine Anfragenachricht enthält aktualisierte Informationen im Buchungsfeld und Pfade aller Buchungsfelder, die im Feld "update_mask" aktualisiert werden sollen. Beispielsweise enthält das Feld "update_mask" einer Anfrage, mit der vorhandene Buchung umgebucht werden sollen, die folgenden zwei Pfade:

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

Weitere Informationen findest du unter FieldMask.

Rückgabewert

UpdateBookingResponse

Kanonische gRPC-Fehlercodes

  • INVALID_ARGUMENT (wenn die angegebene Feldmaske ungültige Werte enthält oder eines der aktualisierten Buchungsfelder ungültig ist)
  • NOT_FOUND (wenn die angegebene Buchungs-ID dem Partner nicht bekannt ist)
// 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;
}