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_bookings
MIDAS API: get_bookings
Returns all bookings between two dates/times
| Required Parameters | Possible Values | Description |
| start | Valid date and time (Format: YYYYMMDDHHMM) | Sets the start of the window for which bookings should be returned |
| end | Valid date and time (Format: YYYYMMDDHHMM) | Sets the end of the window for which bookings should be returned |
| Optional Parameters | Possible Values | Description |
| client | Client ID | Limits returned bookings to a specific client, based on a Client ID (which may first be obtained via a "get_client" call) |
| filter_field | attendees | invoice | notes | Custom Booking Field | The internal name of a custom booking field against which to filter bookings based upon its corresponding "filter_string" value (see below). For example, if you have a custom booking field named "My Field", pass the value "my_field". This parameter will also accept values of "attendees", "invoice", or "notes" to match bookings against attendee numbers, invoice numbers, and booking notes |
| filter_string | String | Used in conjunction with "filter_field" above to return bookings which match a specified value of a custom booking field. |
| filter_type | contains | not_contains | begins_with | ends_with | greater_than | less_than | not_equals | Used in conjunction with "filter_string" above to control how matching bookings are determined. For example, if "filter_field" was set to "my_field", "field_string" was set to "room", and "filter_type" was set to "begins_with", bookings will be returned where the value of the custom "My Field" booking field stars with the phrase "room" - i.e. "room 1", "room 2", etc would be matched, whereas "meeting room" wouldn't be matched as it doesn't start with the phrase "room". "greater_than" and "less_than" values relate to numeric booking fields. If the "filter_type" parameter is omitted, an exact match with the "filter_string" will be enforced. |
| filter_casesensitive | 0 | 1 | Controls the case sensitivity of the "filter_string" parameter above. If set to "1" booking will only be returned which exact match the "filter_string". For example, if "filter_string" contained "room" and "filter_casesensitivity" was set to "1", only bookings matching "room" (and not "Room") would be returned. If the "filter_casesensitive" parameter is omitted, or explicitly set to "0", the case of the "filter_string" value will be ignored. |
| modifed_before | Valid date and time (Format: YYYYMMDDHHMM) | Limits returned bookings to those which were last modified before a specified date/time |
| modifed_since | Valid date and time (Format: YYYYMMDDHHMM) | Limits returned bookings to those which were last modified after a specified date/time |
| type | Booking Type | Limits returned bookings to a specific booking type |
| venue | Venue name | Venue ID | Limits returned bookings to a specific venue name, venue ID, or comma separated list of venue IDs |
| status | all | request | deleted | Controls which bookings are returned. "request" will only return booking requests. "deleted" will only return deleted bookings. "all" will return all bookings (including deleted bookings and booking requests). If this parameter is omitted only confirmed bookings will be returned |
| Example Response ↓ Show |
[
{
"id":"222",
"start":"5/4/2013 @ 13:00",
"end":"5/4/2013 @ 14:00",
"venue_id":"3",
"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"
}
]
},
{
"id":"223",
"start":"5/4/2013 @ 14:15",
"end":"5/4/2013 @ 16:30",
"venue_id":"4",
"venue":"Room 4",
"client":"Some User (Some Org)",
"type":"Community",
"attendees":"40",
"notes":"",
"resources":[],
"invoice":"MIDAS00001",
"history":[
{
"action":"Added",
"date":"2/4/2013 @ 08:25",
"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_id | Internal ID of the venue |
| venue | Name of the 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" |