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: mod_venue
Available in API 2.51+
Modifies an existing venue.Required Parameters | Possible Values | Description |
venue | Venue ID/Name | The name or numerical ID of the existing venue to modify |
Required Parameters (at least 1 required) | Possible Values | Description |
new_name | String | The new name for the existing venue |
new_description | String | The new description for the existing venue (may include HTML) |
new_capacity | Integer | The new capacity (maximum occupancy) of the venue |
new_closed_all | String | Sets the periods during all days of the week during which the venue is "closed". Values are all in 24 hour clock mode, in the format HHMM. To "close" the venue between 11am and 2.30pm, set " new_closed_all " to "11001430 ".To set multiple closed periods, add these on to the string. For example, to close a venue between 11am and 2.30pm and 5pm - 6pm, set " 1100143017001800 ". |
new_closed_mon | String | As "new_closed_all " but applies to Mondays only |
new_closed_tue | String | As "new_closed_all " but applies to Tuesdays only |
new_closed_wed | String | As "new_closed_all " but applies to Wednesdays only |
new_closed_thu | String | As "new_closed_all " but applies to Thursdays only |
new_closed_fri | String | As "new_closed_all " but applies to Fridays only |
new_closed_sat | String | As "new_closed_all " but applies to Saturdays only |
new_closed_sun | String | As "new_closed_all " but applies to Sundays only |
new_rate_all | Decimal | Sets a new venue rate for all days (use in conjunction with the "new_rate_all_type " parameter) |
new_rate_mon | Decimal | Sets a new venue rate for Mondays (use in conjunction with the "new_rate_mon_type " parameter) |
new_rate_tue | Decimal | Sets a new venue rate for Tuesdays (use in conjunction with the "new_rate_tue_type " parameter) |
new_rate_wed | Decimal | Sets a new venue rate for Wednesdays (use in conjunction with the "new_rate_wed_type " parameter) |
new_rate_thu | Decimal | Sets a new venue rate for Thursdays (use in conjunction with the "new_rate_thu_type " parameter) |
new_rate_fri | Decimal | Sets a new venue rate for Fridays (use in conjunction with the "new_rate_fri_type " parameter) |
new_rate_sat | Decimal | Sets a new venue rate for Saturdays (use in conjunction with the "new_rate_sat_type " parameter) |
new_rate_sun | Decimal | Sets a new venue rate for Sundays (use in conjunction with the "new_rate_sun_type " parameter) |
new_rate_all_type | D | H | F | P | Sets the type of venue rate being defined (use in conjunction with the "new_rate_all " parameter). Possible options are "D" (Per day), "H" (Per hour), "F" (Fixed), or "P" (Per person) |
new_rate_mon_type | D | H | F | P | As "new_rate_all_type " but applies to Mondays only (use in conjunction with the "new_rate_mon " parameter) |
new_rate_tue_type | D | H | F | P | As "new_rate_all_type " but applies to Tuesdays only (use in conjunction with the "new_rate_tue " parameter) |
new_rate_wed_type | D | H | F | P | As "new_rate_all_type " but applies to Wednesdays only (use in conjunction with the "new_rate_wed " parameter) |
new_rate_thu_type | D | H | F | P | As "new_rate_all_type " but applies to Thursdays only (use in conjunction with the "new_rate_thu " parameter) |
new_rate_fri_type | D | H | F | P | As "new_rate_all_type " but applies to Fridays only (use in conjunction with the "new_rate_fri " parameter) |
new_rate_sat_type | D | H | F | P | As "new_rate_all_type " but applies to Saturdays only (use in conjunction with the "new_rate_sat " parameter) |
new_rate_sun_type | D | H | F | P | As "new_rate_all_type " but applies to Sundays only (use in conjunction with the "new_rate_sun " parameter) |
new_tax | Decimal | Sets a new (percentage) tax rate for charges for this venue |
new_public | 0 | 1 | Sets whether the venue should be available for public booking/requesting |
new_color | RRGGBB | A hexadecimal color that the venue should appear in in the booking grid |
new_closed | Comma separated list | A comma separated list of date ranges during which the venue is "closed". Values are either in the format YYYYMMDD-YYYYMMDD or epoch-epoch times. Examples: " 20220601-20220614 " (Venue closed 1-14 June 2022 (inclusive))" 20220601- " (Venue closed from 1 June 2022 onwards)" -20220601 " (Venue closed until 1 June 2022)" 20220601-20220607,20220614-20220620 " (Venue closed 1-7 and 14-20 June 2022 (inclusive)) |
new_managers | Comma separated list | A comma separated list of numeric user IDs to assign as the "managers" of the venue |
new_blocks | Comma separated list | A comma separated list of numeric venue IDs to prevent (block) from being able to be booked at the same time as the venue being modified |
new_alternatives | Comma separated list | A comma separated list of numeric venue IDs to offer as suitable alternative venues in the event of unavailability for the venue being modified |
Example Response |
{ "venue_modified":"6" } |
Variables Returned | Description |
venue_modified | The unique internal ID corresponding the modified venue |