Using the Advanced API Calls
Mazevo has several advanced API calls that are licensed separately from the standard API Calls
The calls in this section are licensed separately from other calls and are designed for a very specific use case. Please contact Mazevo support for additional information.
Create Booking Calls
The following calls manage a contact's bookings (create and cancel). The calls are in the PublicRequest directory.
- APIVersion (Get) - Returns the current version of the API. This is primarily used to test connectivity to the Mazevo API endpoint.
- Authenticate (Post) - Returns a security token passed into other public request calls. Parameters: contact email, security policy ID. The token expires after 10 minutes. This call can also create a new contact by passing in the following optional parameters: firstName, lastName, and autoCreateContact. Auto Create contact is a true/false parameter; if set to true, it will attempt to create a new contact record using the email and name parameters. The call returns a token and the contact ID of the new contact.
- GetMyRooms (Get) - Returns a list of buildings and rooms tied to the security policy. Parameters: token (from Authenticate call passed as bearer token).
- GetMyBookings (Post) - Returns a list of bookings for the contact. Parameters: token (from Authenticate call passed as bearer token), Optional Parameters: Start Date/Time, End Date/Time. If the start and end date/times are passed in, the call returns the bookings for the contact within that date range. Otherwise, it returns only current and future bookings.
- CreateBooking (Post) - Creates a booking and associated event record. Parameters: token (from Authenticate call passed as bearer token), EventName, RoomID, Attendance, StartDateTime, EndDateTime.
- CancelBooking (Get) - Cancels a single booking, setting the status to the appropriate status in the security policy. Parameters: token (from Authenticate call passed as bearer token), BookingID.
User and Security Calls
The following calls are used to retrieve and update user accounts. The calls are in the PublicUser directory.
- SecurityPolicies (Get) - Returns a list of all security policy records.
- GetRequester (Post) - Returns a single user's email, first name, last name, phone, and security policy ID. Parameters: email.
- UpdateRequesterSecurity (Post) - Used to update a single user's security policy. Parameters: email, newSecurityPolicyID.
- UpdateRequester (Post) - Used to update a single user's account details. Parameters: email, newFirstName, newLastName, newPhoneNumber, newSecurityPolicyID. The email address can not be changed with this call.
- NewRequesters (Get) - Returns a list of new user accounts created by SSO.
External Service Provider Integration
- ExternalServiceProviders (Get) - Returns a list of External Service Providers.
- ExternalResources (Get) - Returns a list of External Resources.
- AddExternalResource (Post) - Adds a single external resource record. The description is required.
- UpdateExternalResource (Post) - Updates a single external resource record.
- GetEventswithExternalResources (Post) - Returns a list of bookings and their associated external resources.
- Parameters: Start Date/Time, End Date/Time.
- Available Filters: BuildingIds, RoomIDs, EventTypeIDs, StatusIDs.
- Optional Parameter: minDateChanged. Only bookings with critical changes (date, time, status, room) after this date/time will be returned when using this optional parameter.