Lease (location) – Spécification

Remarque :La fonctionnalité de location est facultative dans la version 2 de l'API. Nous vous recommandons d'utiliser plutôt CheckAvailability.

La création d'une location constitue la première étape de création d'une réservation. Le backend du partenaire vérifie que le créneau horaire demandé est valide et disponible. En interne, le partenaire crée une préservation temporaire pour le créneau demandé, qui est configuré pour expirer automatiquement à l'heure spécifiée dans lease_expiration_time. Le backend est autorisé à modifier la valeur lease_expiration_time (par exemple dans le cas où la durée de location demandée est trop longue). La location ainsi créée est renvoyée au client.

// Temporary lease for an inventory slot
message Lease {
  // ID of the lease. Ignored when creating a lease.
  string lease_id = 1;

  // ID of the merchant for the slot
  string merchant_id = 2;

  // ID of the merchant service
  string service_id = 3;

  // Start time of the appointment slot
  google.protobuf.Timestamp start_time = 4;

  // Duration of the appointment slot
  google.protobuf.Duration duration = 5;

  // Opaque tag that identifies the availability slot and matches the value
  // provided in the availability feed.
  string availability_tag = 8;

  // The set of resources that disambiguates the appointment slot, e.g. by
  // indicating the staff member and room selected by the user.
  Resources resources = 9;

  // Unique identifier for this lease, chosen by the client. Serves as an
  // idempotency token for [ext.maps.booking.partner.v0.CreateLease] requests.
  string client_reference = 6;

  // Expiration time of the lease
  google.protobuf.Timestamp lease_expiration_time = 7;
}

// Reference to a [ext.maps.booking.partner.v0.Lease] that has been created via
// [ext.maps.booking.partner.v0.CreateLease]
message LeaseReference {
  // Lease ID
  string lease_id = 1;
}