Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venue_groups
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: get_availability
MIDAS API: get_availability
Checks whether a venue is available (free) for booking between two dates/times
| Required Parameters | Possible Values | Description |
| start | Valid date and time (Format: YYYYMMDDHHMM) | Start time |
| end | Valid date and time (Format: YYYYMMDDHHMM) | End time |
| venue | Venue name | Venue |
| Optional Parameters | Possible Values | Description |
| attendees | number | The number of desired attendees. If specified, availability will also be dependent upon whether the number of attendees if less than the venue's capacity and/or maximum global occupancy levels. |
| pre | number | The number of minutes setup time before the booking start time |
| post | number | The number of minutes breakdown time after the booking end time |
| Example Response ↓ Show |
{
"availability":"1"
} |
| Variables Returned | Description |
| availability | Current Venue Availability. A value of "1" means the venue is "available" on the dates/times specified. A value of "Unavailable" means the venue is not available on the dates/times specified (i.e. clashes with an existing booking). Any other values also mean "Unavailable" but will specify the reason for the unavailability i.e. "This will exceed your maximum occupancy level", or "Venue unavailable from 6/5/2103" |