Documentation

Reservable

Fields marked with ? are conditionally present.

{
  'reservable_id': <str>,
  'reservable_site_ordinal_id': <dec>,
  'reservable_type': <str>,

  'active': <bool>,
  'allow_accessory_users': <bool>,
  'anyapprovers': <bool>,
  'barcode': <str>,
  'bgcolor': <str, none>,

  'buffer_after': <dec>, # seconds
  'buffer_applies_to_blocking': <bool>,
  'buffer_before': <dec>, # seconds

  'can_return': <bool>,
  'category': <str>,
  'class'?: <str>,
  'currency'?: <str>,
  'default_calendar_view': <str, none>,
  'enable_end_early': <bool>,

  # Only present for requestable resource Reservables.
  # Each event uses the Reservation data dictionary produced by
  # Reservation.as_dict_script_engine().
  'events'?: [ <Reservation> ],

  'future_loans': <bool>,
  'is_addon': <bool>,
  'loanable': <bool>,

  'name': <str>,
  'rate_name_only': <bool>,
  'rate_quotes': <bool>,
  'rate_quotes_require_account_number': <bool>,

  'reservable': <bool>,

  'reservation_max_duration'?: <dec>, # seconds
  'reservation_minimum'?: <dec>, # seconds
  'reservation_unit_limit'?: <dec>,

  'require_purpose': <bool>,
  'restricted_to_templates_only': <bool>,
  'returnable': <bool>,

  'show_account_number_on_reservations': <bool>,
  'show_big_button_on_site_page': <bool>,
  'show_name_override_on_reservations': <bool>,
  'show_note_on_reservations': <bool>,
  'show_projects_on_reservations': <bool>,
  'show_purpose_on_reservations': <bool>,

  'skip_global_forms': <bool>,
  'sku': <str>,

  # Only present for a timeless-template Reservable with an associated
  # template reservation. This uses the Reservation data dictionary
  # produced by Reservation.as_dict_script_engine().
  'template_reservation'?: <Reservation>,

  'units': <dec>,
  'units_name': <str>,
  'units_mode': <str>, # "numbered" or "named"

  # Only present when the Reservable has a units account.
  'units_a_f_t_id'?: <str>,
  'units_account_email_notification'?: <bool, none>,
  'units_account_email_notification_custom_message'?: <str, none>,
  'units_account_email_notification_threshold'?: <dec, none>,
}