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_user
MIDAS API: get_user
Returns user information
| Required Parameters (at least 1 required) | Possible Values | Description |
| user's email | User's email address | |
| user | user's name | User's name |
| Optional Parameters | Possible Values | Description |
| match | exact | loose | Allows specifying the closeness of the match. If match is set "exact" and "client" is set to "Joe Bloggs", only clients with the name "Joe Bloggs" will be returned. If match is set to "loose" and "email" is set to "@mid.as", any client with an "@mid.as" email address will be returned. If the match parameter is omitted only exact matches are returned |
| Example Response ↓ Show |
{
{
"name":"Joe Bloggs",
"email":"[email protected]",
"added":"25/2/2013 @ 16:49",
"last_login":"23/4/2013 @ 20:51",
"last_password_change":"29/3/2013 @ 18:34",
"last_modified":"25/2/2013 @ 23:42",
"account_locked":"0",
"failed_login_attempts":"0",
"day_starts_at":"00",
"day_runs_for":"24",
"do_not_log_activity":"0"
"email_calendar_events":"1",
"email_messages":"0",
"email_pending_notifications":"1",
"email_watch_notifications":"0",
"force_pw_change_at_login":"0",
"suppress_messages_popup":"0",
"venue_group_access":"Group A,Group B",
"permissions":[
{
"can_add_bookings":"1",
"can_add_clients":"1",
"can_add_day_notes":"1",
"can_add_historical_bookings":"0",
"can_add_out_of_hours_bookings":"0",
"can_change_password":"1",
"can_delete_bookings":"2",
"can_delete_clients":"1",
"can_email_clients":"1",
"can_evac":"1",
"can_invoice":"1",
"can_manage_addons":"1",
"can_manage_booking_types":"1",
"can_manage_midas":"1",
"can_manage_resources":"1",
"can_manage_users":"1",
"can_manage_venues":"1",
"can_modify_bookings":"2",
"can_modify_clients":"0",
"can_print":"1",
"can_process_requests":"1",
"can_restore_bookings":"1",
"can_use_mymessages":"1",
"can_view_activity_log":"1",
"can_view_clients":"2",
"can_view_statistics":"1",
"max_booking_length":"120",
"max_bookings":"4",
"max_bookings_per":"D"
}
]
}
} |
| Variables Returned | Description |
| name | User's name |
| User's email address | |
| added | Date/Time user was added to MIDAS |
| last_login | Date/Time user last successfully logged in |
| last_password_change | Date/Time user last changed their password |
| last_modified | Date/Time user information was last modified |
| account_locked | Indicates if the user has been suspended / locked out of MIDAS |
| failed_login_attempts | The number of unsuccessful login attempt on this account since last successful login |
| day_starts_at | The hour (in 24-hour clock mode) the user's booking grid is displayed from |
| day_runs_for | The number of hours the user's booking grid displays |
| do_not_log_activity | If "0" all user activity within MIDAS will be recorded in the Recent Activity Log If "1" user activity within MIDAS will appear in the Recent Activity Log, except for logins/logouts If "2" no user activity will be recorded in the Recent Activity Log |
| email_calendar_events | Indicates whether reminders should also be sent to user's email as calendar events |
| email_messages | Indicates whether messages are forwarded to user's email |
| email_pending_notifications | Indicates whether new booking request notifications are forwarded to user's email |
| email_watch_notifications | Indicates whether watch notifications are forwarded to user's email |
| force_pw_change_at_login | Indicates whether user is required to change their password upon next login |
| suppress_messages_popup | Indicates whether the "My Messages" pop-up is suppressed (not shown) after login |
| venue_group_access | Indicates which Venue Groups the user has access to in the Booking Grid. A value of "*" indicates user can view all Venue Groups |
| permissions | The various permissions associated with the user account. Most take a value of either "1" meaning user has been granted a permission, "0" meaning the user does not have a permission. Permissions with additional possible values are indicated. |
| can_add_bookings | User can add bookings. "0" indicates user may not make bookings "1" indicates user may make bookings "2" indicates user may only make booking requests |
| can_add_clients | User can add clients |
| can_add_day_notes | Use can add notes to calendar dates |
| can_add_historical_bookings | User can add bookings for dates occurring in the past |
| can_add_out_of_hours_bookings | User can add bookings outside of a venue's operating hours |
| can_change_password | User can change their password |
| can_delete_bookings | User can delete bookings "0" indicates user cannot delete any bookings "1" indicates user may delete only those bookings originally added by them "2" indicates user may delete any booking |
| can_delete_clients | User can delete clients |
| can_email_clients | User can email clients directly from MIDAS |
| can_evac | User can print Emergency Evacuation data |
| can_invoice | User can use invoicing |
| can_manage_addons | User can manage MIDAS addon settings (For more information on available addons for MIDAS, please see https://mid.as/addons) |
| can_manage_booking_types | User can manage Booking Types |
| can_manage_midas | User can manage MIDAS |
| can_manage_resources | User can manage Resources |
| can_manage_users | User can manage Users & Permissions |
| can_manage_venues | User can manage Venues |
| can_modify_bookings | User can modify bookings "0" indicates user cannot modify any bookings "1" indicates user may modify only those bookings originally added by them "2" indicates user may modify any booking |
| can_modify_clients | User can modify clients |
| can_print | User can use print functions |
| can_process_requests | User can approve/reject pending booking requests |
| can_restore_bookings | User can restore previously deleted bookings |
| can_use_mymessages | Use can use My Messages (Messages, Reminders, and Watches) |
| can_view_activity_log | Use can access the Recent Activity log |
| can_view_clients | User can view client information "0" indicates user cannot view any client data "1" indicates user can view client and organization names only "2" indicates user can view full client info for any client "3" indicates user can only view full client into for clients they've added bookings for |
| can_view_statistics | Use can access Statistics |
| max_booking_length | The maximum duration (in minutes) that the user is permitted to make any single booking for |
| max_bookings | The maximum number of bookings the user may add to any given period (determined by "max_bookings_per" value) |
| max_bookings_per | The period over which the "max_bookings" value applies. Possible values are: "D" - Single date "W" - Week "M" - Month "Y" - Year |