MIDAS API: API Command Reference

Below is an alphabetical list of all currently available API calls, together with a description of their purpose, and whether they require full-access to the API (with Read-Only Mode DISABLED).

API Call	Description	Requires API in Full-Access Mode?
add_booking	Adds a new booking
add_client	Adds a new client
add_invoice	Adds a new invoice
add_resource	Adds a new resource
approve_request	Approves a booking request
authenticate_user	Authenticate against a MIDAS user account
del_booking	Deletes an existing booking
del_bookings	Deletes multiple bookings across a date range
del_client	Deletes a client
del_invoice	Deletes an invoice
del_resource	Deletes a resource
email_client	Sends an email to a client
gen_invoice	Automatically generate invoice(s)
get_activity	Returns all MIDAS user activity between two dates/times
get_availability	Checks whether a venue is available (free) for booking between two dates/times
get_booking	Returns details of a single booking
get_booking_type	Returns details of a specific booking type
get_booking_types	Returns all currently defined booking types and their corresponding internal IDs
get_bookings	Returns details of all bookings between two dates/times
get_client	Returns details of a client
get_consumable_levels	Returns current available consumable quantities
get_invoice	Returns details of an invoice
get_invoices	Retrieves a list of invoices for a specific client
get_messages	Retrieves all current internal messages for a specific user
get_reminders	Retrieves all current reminders for a specific user
get_resource	Returns details of a resource item
get_resource_availability	Returns the quantity available of a specified resource between two dates/times
get_setting	Returns a current MIDAS setting
get_template	Returns the contents of a template
get_user	Returns user information
get_users_logged_in	Returns a list of currently logged in users
get_venue	Returns venue information
get_venues	Returns a complete set of venue names together with their corresponding internal IDs
get_venues_in_group	Returns a list of venues in a particular Venue Group
get_venues_in_use	Returns a list of all venues currently in use
get_watches	Retrieves all current watches for a specific user
mod_booking	Modifies an existing booking
mod_client	Modifies an existing client
mod_invoice	Modifies/Updates an existing invoice
mod_resource	Modifies an existing resource
mod_venue	Modifies an existing venue
notify_user	Send a message/reminder to another user
reject_request	Rejects a booking request
restore_booking	Re-instates a recently deleted booking
set_setting	Set/Change a MIDAS setting
set_template	Set/Modify a template
util_api_usage	Returns details of recent API usage
util_from_epoch	Converts epoch seconds to a standard date/time format
util_to_epoch	Converts a date/time to epoch seconds