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_booking
Available in API 2.0+
Modifies an existing booking
Required Parameters | Possible Values | Description |
id | Booking ID | The unique numeric ID of the booking to be modified |
new_type
" parameter. To change the venue and the type and the venue, pass both "new_type
" and "new_venue
".
Optional Parameters (One or more required) | Possible Values | Description |
new_start | Valid date and time (Format: YYYYMMDDHHMM) | The new start date/time the booking should be changed to |
new_end | Valid date and time (Format: YYYYMMDDHHMM) | The new end date/time the booking should be changed to |
new_venue | Venue ID | Venue Name | The numeric ID or name of the venue the booking should be changed to |
new_pre | Number | The number of minutes setup time before the booking start time |
new_post | Number | The number of minutes breakdown time after the booking end time |
new_client | Client ID | The numeric ID of the client the booking should be changed to |
new_type | Type ID | Type Name | The numeric ID of the Booking Type, or the name of the Booking Type the booking should be changed to |
new_attendees | Number | The new number of booking attendees |
new_notes | String | New notes about the booking |
new_resources | Quantity & Resource ID | Resource Name | New resources to be added to the booking. Values should be passed as "qty|resource (ID or name)".For example, to add 2 Tables to a booking, pass " 2|Tables ".This parameter can be added multiple times to add further resources Note: Passing the " new_resources " parameter will remove any previous resources that had been assigned to the booking |
new_custom fields | Custom value | If you've defined custom booking fields in your MIDAS, you can optionally specify new values for these fields for the booking you're modifying. For example, if you have a custom field named "Insurance", you would pass the parameter " new_insurance " together with the new value you wish to set |
Optional Parameters | Possible Values | Description |
accept_limited_resources | 0 | 1 | If you're specifying new resources for a booking, this parameter determines whether the bookings should still be modified if the quantity of resources requested isn't available. For example, if you add 10 Tables to a booking, yet only 5 Tables are available, an error will be returned and the booking won't be modified. However, passing the " accept_limited_resources " parameter with a value of "1 " will continue the modify booking, but with reduced resource quantities (in the previous example, this would mean that only 5 Tables would be added to the booking, instead of the desired 10) |
no_watches | 0 | 1 | Setting the "no_watches " parameter to "1 " will suppress generation of Watch notifications for users who are monitoring modified bookings, otherwise omitting this parameter (or setting it to "0 ") will allow Watch notifications to be generated accordingly |
Example Response |
{ "booking_modified":"1" } |
Variables Returned (on success) | Description |
booking_modified | Returns "1 " if the booking was successfully modified |
Variables Returned (on error) | Description |
error | The reason why the booking couldn't be modified. Examples include:
Unavailable (clashes with an existing booking)
Unavailable - Blocked By Meeting Room 1
45 Attendees will exceed the maximum capacity of Meeting Room 1 (15)
Outside Operating Hours
Venue unavailable from 1/1/2015
Venue unavailable between 1/1/2015-1/2/2015
Venue not available until 1/1/2015
Only x5 Tables Available
|