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_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_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- C#
- Java
- jQuery
- .NET
- Perl
- PHP
- Python
- Ruby
- Troubleshooting
- Release Notes
MIDAS API: Release Notes
v2.3 | |
22nd October 2019 | · · Update: Compatibility for MIDAS v4.23 · Fixed: filter_field/filter_string parameters of "get_bookings " call may return "filter field not found" in some instances |
v2.34 | |
13th May 2019 | · · Update: Compatibility for MIDAS v4.22 |
v2.33 | |
8th May 2019 | · Fixed: Unable to save settings in some instances · Fixed: After saving settings, Save Settings button may not display anything |
v2.32 | |
10th April 2019 | · Fixed: "del_invoice " call didn't remove deleted invoice reference from existing bookings |
v2.31 | |
2nd March 2019 | · Fixed: "closed_between " parameter of "get_venue " call may return invalid JSON in the event no "closed between" times set for selected venue. |
v2.30 | |
29th January 2019 | · · New: Optional "unsent " parameter added to "get_invoices " call to limit returned invoices to those which are unsent· Update: Compatibility for MIDAS v4.21 |
v2.29 | |
18th December 2018 | · Fixed: Support for Perl 5.26+ |
v2.28 | |
15th November 2018 | · · New: "runas " parameter - similar to existing "logas " parameter, but enforces specified user's permissions when making API calls. (If both "logas " and "runas " are supplied, "runas " will override "logas ")· Improved: " authenticate_user " call now accepts optional "include_locke d" parameter to allow authenticating even if user account is locked/suspended· Improved: " authenticate_user " call now accepts optional "bypass_fail_count " parameter to allow bypassing of failed login count checking/incrementing |
v2.27 | |
27th September 2018 | · Update: Icon compatibility for MIDAS v4.20 · Improved: " get_bookings " call can now accept "modified_since " and "modified_before " parameters to restrict results to those bookings modified before/since a given date and time· Improved: " get_bookings " call can now filter by custom field (new "filter_field ", "filter_string ", "filter_type ", and "filter_casesensitive " parameters) |
v2.26 | |
16th June 2018 | · Improved: Error response distinguishes between missing and invalid API key · Experimental: Ability to explicitly specify base directory when calling via command line (via "path" parameter") |
v2.25 | |
25th April 2018 | · Updated: MIDAS v4.19 compatibility · Fixed: new_start /new_end parameters of mod_booking call always defaulted to epoch times, even if epoch flag wasn't explicitly set· Fixed: Encoding issue with history concatenations |
v2.24 | |
23rd March 2018 | · New: "get_users_logged_in " call· Optimization: Code cleanup |
v2.23 | |
30th November 2017 | · Updated: MIDAS v4.17 compatibility · Fixed: Rounding on some systems |
v2.22 | |
28th September 2017 | · Fixed: Path issues when called via command line |
v2.21 | |
20th September 2017 | · Fixed: Simultaneous multiple add/modify booking queries on slow servers may not correctly detect conflicts · Fixed: Encoding issues in booking history · Fixed: API logging may not correctly log timestamps for some API calls |
v2.20 | |
28th August 2017 | · Fixed: "get_resource " returned category in place of qty |
v2.19 | |
12th August 2017 | · New: Command line support · New: Optional JSONP support · Updated: MIDAS v4.16 compatibility |
v2.18 | |
15th April 2017 | · Change: "get_venues " call now sorts venues in the order they're currently arranged in within MIDAS (rather than in the order they were added to MIDAS)· Updated: MIDAS v4.15 compatibility · Improved: API now returns 401 Unauthorized http status code when invalid API key specified · Improved: API logging now also includes more readable timestamps · Improved: API logging now indicates http request method · Improved: API logging now indicates size of JSON data response · Fixed: Tabs not correctly escaped in JSON responses · Fixed: Timestamps may not correctly reflect timezone setting · Fixed: " del_booking " and "del_bookings " API calls made without the "force" parameter set may allow bookings to be deleted multiple times· Fixed: " del_booking " and "del_bookings " API calls made without the "force" parameter may not correctly update the booking's history record |
v2.17 | |
9th March 2017 | · Fixed: "get_availability " call may return "unknown venue" error |
v2.16 | |
8th March 2017 | · Fixed: "del_booking " and "del_bookings " calls may not correct log to Recent Activity |
v2.15 | |
2nd November 2016 | · Update for MIDAS v4.14 compatibility · Fixed: " get_availability " wouldn't check dates in the past |
v2.14 | |
25th July 2016 | · Added: "get_venues " call to retrieve all venue IDs/names· Improved: " get_bookings " call can now also accept a venue ID (or comma separated list of venue ID's) instead of a venue names for the "venue" parameter· Improved: " get_bookings " call now also returns internal venue ID in "venue_id" parameter· Improved: " get_venue " call now also returns internal venue ID in "id" parameter· Improved: " get_venue " call now also accept a venue ID instead of a venue names for the "venue" parameter· Improved: Handling of database connection errors |
v2.13 | |
12th July 2016 | · Added: Support for client credit & invoice discounts · Improved: Validation of API Key |
v2.12 | |
24th February 2016 | · Improved: Character set for responses now implicitly set to UTF-8 |
v2.11 | |
10th February 2016 | · Added: "authenticate_user " call· Added: Support for actioning API calls under individual user accounts |
v2.10 | |
28th January 2016 | · Update for MIDAS v4.11 compatibility · Added: Support for passing API key via an X-API-KEY HTTP header · Improved: " get_user " call now returns "max_booking_length" and "max_bookings_per_date" permissions· Improved: The API will now automatically reject non-GET/POST http methods |
v2.09 | |
18th August 2015 | · Update for MIDAS v4.10 compatibility |
v2.08 | |
13th July 2015 | · Improved: "get_bookings " call can now be restricted to an individual client· Change: " get_client " call now returns "id" in place of "client_id" |
v2.07 | |
22nd May 2015 | · Added: "get_resource " call· Improved: " get_venue " call now returns blocks and alternatives· Improved: Logging when calls fail/error produced |
v2.06 | |
28th February 2015 | · Fixed: Some JSON responses don't correctly validate |
v2.05 | |
10th February 2015 | · Fixed: Some settings not being correctly loaded if API run in isolation (without a concurrent login) |
v2.04 | |
9th February 2015 | · Fixed: New line characters not being correctly escaped in some API responses |
v2.03 | |
1st February 2015 | · Fixed: Quotation marks not being correctly escaped in some API responses |
v2.02 | |
19th January 2015 | · Fixed: If multiple databases are in use, it may not be possible to access the Manage Addons screen from additional databases |
v2.01 | |
2nd January 2015 | · Fixed: Multi-database support |
v2.00 | |
1st September 2014 | The API now allows bi-directional communication with MIDAS - meaning you can now add/set/change data as well as reading it. The following new API calls have been implemented: |
v1.03 | |
20th March 2014 | · Added: "member_of" to the list of returned values for the "get_venue " call· Change: Format of "rates" information returned by " get_venue " call · Update for MIDAS v4.06· Fixed: "closed_from"/"closed_to" values from " get_venue " call may return 1/1/1970 |
v1.02 | |
18th February 2014 | · Added: Support for multiple databases |
v1.01 | |
7th October 2013 | · Added: "get_venues_in_use " call |
v1.00 | |
1st June 2013 | · Initial release of the MIDAS API Access Addon (for MIDAS v4.03+) |