Méthode UpdateBooking

Requête

UpdateBookingRequest

Un message de requête contient de nouvelles informations dans le champ de réservation et répertorie les chemins vers tous les champs de réservation à mettre à jour dans le champ update_mask. Par exemple, le champ update_mask d'une requête qui replanifie une réservation existante contient les deux chemins suivants :

  paths: "start_time"
  paths: "duration"

Pour en savoir plus, consultez la section sur FieldMask.

Valeur renvoyée :

UpdateBookingResponse

Codes d'erreur gRPC canoniques

• INVALID_ARGUMENT (le masque de champ fourni contient des valeurs non valides, ou l'un des champs de réservation mis à jour est incorrect ; cela inclut le cas où la mise à jour du champ n'est pas autorisée par la logique métier, par exemple parce qu'il est trop tard pour annuler la réservation)
• NOT_FOUND (le partenaire ne reconnaît pas l'ID de réservation fourni)
• RESOURCE_EXHAUSTED (le créneau correspondant à l'heure de début mise à jour n'est pas disponible)

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