api.reservations.count
Fetch the number of reservations within some filter parameters. All API calls are executed from that database perspective of the reservation having already been made, so the current reservation being made will be counted in the results.
Arguments:
def api.reservations.count(
account_number: str = None, # Filter on account number set on reservation
end: datetime = None, # End time of filter
include_blocked: bool = False, # Boolean for including reservations of resources that block any filtered resources.
include_cancelled: bool = False, # Boolean for including cancelled reservations.
include_ical_feeds: bool = False, # Boolean for including ical feeds
include_maintenance: bool = False, # Boolean for blocking maintenance
include_maintenance_nonblocking: bool = False, # Boolean to included nonblocking if above is true
include_templates: bool = True, # Boolean for including template reservations
requests: bool = None, # Boolean for filtering on requests instead of reservations
reservable_id: str = None, # Resource ID
start: datetime = None, # Start time of filter
tags: list of str = None, # Tags to filter on (case insensitive)
user_id: str = None, # User ID to filter on
usergroup_name: str = None, # User group name to filter on (case insensitive)
):
Returns decimal
value.
Example:
num_reservations = api.reservations.count(reservable_id="foo") # num_reservations = <dec>