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_venue
Returns venue information
Required Parameters | Possible Values | Description |
venue | Venue name | Venue ID | Venue name or internal venue ID |
Optional Parameters | Possible Values | Description |
match | exact | loose | Allows specifying the closeness of the match. If match is set "exact" and "venue" is set to "Meeting Room", only venues with named "Meeting Room" will be returned. If match is set to "loose" and "venue" is set to "Meeting Room", any venue containing the name "Meeting Room" (such as "Meeting Room 1", "Meeting Room 2", "Meeting Room 3", etc will be returned. If the match parameter is omitted only exact matches are returned |
Example Response ↓ Show |
[ { "id":"1", "venue":"Room 1", "capacity":"20", "description":"A small meeting room", "public":"1", "rates":[ { "Mon":[ { "rate":"100.00", "rate_length":"1", "rate_type":"Hourly" }, { "rate":"80.00", "rate_length":"4", "rate_type":"Hourly" }, { "rate":"450.00", "rate_length":"6", "rate_type":"Booking" } ], "Tue":[ { "rate":"20.00", "rate_type":"Hourly" } ], "Wed":[ { "rate":"20.00", "rate_type":"Hourly" } ], "Thu":[ { "rate":"20.00", "rate_type":"Hourly" } ], "Fri":[ { "rate":"20.00", "rate_type":"Hourly" } ], "Sat":[ { "rate":"20.00", "rate_type":"Hourly" } ], "Sun":[ { "rate":"20.00", "rate_type":"Hourly" } ] } ], "tax":"20.00", "operating_hours":[ { "day":"Mon", "closed":"0000-0800,2100-2400", }, { "day":"Tue", "closed":"0000-0800,2100-2400", }, { "day":"Wed", "closed":"0000-0800,2100-2400", }, { "day":"Thu", "closed":"0000-0800,2100-2400", }, { "day":"Fri", "closed":"0000-0800,2100-2400", }, { "day":"Sat", "closed":"0000-0930,2000-2400", }, { "day":"Sun", "closed":"0000-1000,1600-2400" } ], "closed_from":"", "closed_until":"1/4/2015", "managers":"Jane Doe,Joe Bloggs", "member_of":"Group A,Group B", "blocks":"Room 4", "alternatives":"Room 2,Room 3" } ] |
Variables Returned | Description |
id | Internal venue ID |
venue | Venue name |
capacity | The maximum occupancy of the venue |
description | The venue's description |
public | Whether the venue is available for public booking/requesting |
rates | The room rate/hire charge for each day of the week |
<day> | Can be one of the following: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" to denote subsequent rate information for each day of the week |
rate | The room/rate hire charge amount |
rate_length | The minimum length of the booking the rate applies to (in hours) |
rate_type | If "Hourly", the rate is per-hour, if "Daily", the rate is per-day, if "Booking", the rate is per-booking |
tax | The percentage tax rate to charge on venue rates |
operating_hours | The times between which the venue is closed during each day of the week |
day | The day of the week |
closed | A comma separated list of the times (24 hour format) the venue is closed |
closed_from | The date after which the venue is considered closed |
closed_until | The date until which the venue is considered closed |
managers | A comma separated list of user who are "Managers" of the venue i.e. can approve Booking Requests for the venue |
member_of | A comma separated list of Venue Groups to which the venue belongs to |
blocks | A comma separated list of venues which are automatically blocked (Unavailable) when this venue has an ongoing booking |
alternatives | A comma separated list of venues which should be considered as alternatives to this venue |