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_booking
Available in API 2.0+
Returns details of a specific booking
Required Parameters | Possible Values | Description |
id | Booking ID | The unique numerical reference of the booking |
Example Response ↓ Show |
{ "id":"222", "start":"5/4/2013 @ 13:00", "end":"5/4/2013 @ 14:00", "venue":"Room 3", "client":"Some User (Some Org)", "type":"Community", "attendees":"30", "notes":"", "resources":[ { "resource":"Laptop", "qty":"2" }, { "resource":"Projector", "qty":"1" } ], "invoice":"MIDAS00001", "history":[ { "action":"Added", "date":"2/4/2013 @ 08:23", "user":"Joe Bloggs" }, { "action":"Modified", "date":"2/4/2013 @ 16:52", "user":"Joe Bloggs" } ], "status":"confirmed" } |
Variables Returned | Description |
id | Internal Booking ID |
start | Start date/time of booking |
end | End date/time of booking |
venue | Venue |
client | Client the booking is for |
type | Booking Type |
attendees | Estimated number of people attending booking |
notes | Booking Notes |
resources | Resources assigned to booking |
resource | The name of the resource |
qty | The quantity of the resource |
invoice | Invoice in which the booking appears |
history | Booking history |
action | The action performed. This will be one of the following: "Booking Request Received", "Added", "Modified", "Deleted", "Restored", or "Invoice Created" |
date | The date/time the action occurred |
user | The user who performed the action |
custom fields | Any custom booking fields setup in your MIDAS will also be returned |
status | Denotes whether the booking is a "request ", a "confirmed " booking, or whether it has been "deleted " |