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 Responses
MIDAS API ResponsesJSON
By default, the MIDAS API returns JSON (JavaScript Object Notation) formatted data. Example JSON responses are shown throughout the API Command Reference for each API call. Error responses are also returned in JSON format and denoted by the term "error".
JSONP
Optionally, the MIDAS API (from API v2.19 onwards) can return JSONP (JSON with Padding) data.JSONP is a method commonly used to bypass the cross-domain policies in web browsers. Typically, modern browsers won't allow you to make AJAX (Asynchronous JavaScript) requests from one domain to another domain perceived to be on a different server.
For example, if your MIDAS system is running on server A, and you wish to make client-side API calls through JavaScript, you would typically only be able to make such AJAX requests from pages residing on server A itself. Attempting to initiate an AJAX request for server A from server B would be blocked by the user's browser.
JSON and JSONP behave differently on the client and the server. JSONP requests are not dispatched using the XMLHTTPRequest and the associated browser methods. Instead, a <script> tag is created, the source of which is set to the target URL. This script tag is then added to the DOM (normally inside the <head> element).
JSONP support in the MIDAS API (which is disabled by default) can be enabled via the API settings screen.
With JSONP support enabled, you'd then be able to pass the name of a JavaScript function in a "callback" parameter along with your API calls.
Consider a simple API call to retrieve the version number of MIDAS (passing the "action" parameter with a value of "get_setting", and a "setting" parameter with a value of "version"). The typical JSON response would be:
| Example JSON Response: |
{"version":"4.37"} |
Now consider the same API call, with JSONP support enabled, and an additional "callback" parameter passed with a value of "myfunction"). The JSONP response would then be:
| Example JSONP Response: |
myfunction({"version":"4.37"}) |
The "callback" parameter must contain the name of an existing JavaScript function on the calling page.
Upon receiving the JSONP response, the user's browser will execute the "myfunction" JavaScript function, passing the JSON data {"version":"4.37"} to it accordingly.