Using the Mazevo API

Mazévo has a built-in API (application programming interface) available to all customers who use the system.

API Calls

The following calls are used to retrieve internal record IDs. The IDs returned by these calls will be used with other calls to filter the results.  All results for all calls are returned in JSON.

  • GetBuildings (Get) - Returns a list of Buildings.  
  • GetEventTypes (Get) - Returns a list of Event Types.  
  • GetResources (Get) - Returns a list of Resources. Available Filters: ServiceProviderID
  • GetRooms (Post) - Returns a list of Rooms. Available Filters: BuildingID
  • GetRoomTypes (Get) - Returns a list of Room Types.  
  • GetServiceProviders (Get) - Returns a list of Service Providers.  
  • GetStatuses (Get) - Returns a list of Statuses.  
  • GetBuildingHours (Post) - Returns the open and close time for a specific building for a selected date. Additionally, if the building is closed all day, the 'closedAllDay' field will be false. Parameters: Building ID, Date

The following calls return event-related data. For each call, different parameters and filters are available.

  • GetEvents( Post) - Returns a list of events (bookings) based upon the filters passed into the call.  Parameters: Start Date/Time, End Date/Time Available Filters:  BuildingIds, RoomIDs, EventTypeIDs, StatusIDs, ResourceIDs.
  • GetResourceDetails( Post) - Returns a list of resources requested for each booking. Parameters: BookingIDs, ResourceIds (optional). Resource IDs are used to limit the results to specific resources. If no resource Ids are passed in, all resources for each booking are returned.
  • GetTodaysEvents (Post) - Returns a list of the events (bookings) for a specific room for the current day. This call is used for room signage applications. Parameters: RoomID

The following call is used to load academic courses into Mazévo:

  • ImportTerm (Post) - Used to upload academic course data for an entire term.

 

The following calls are used to manage Organizations, Contacts, Organization/Contact relations:

  • Organizations (Post) - Used to upload a list of organizations. This call would be used to send a list of student organizations to Mazévo.
  • Contacts (Post) - Used to upload a list of contacts.  This would be a list of all students that are associated with one or more organizations.  Each contact would appear on this list one time.
  • OrgMembership (Post) - Used to tie organizations and contacts together.
When using Organizations, Contacts, and OrgMembership calls, it is important you push up all records for each call, not just new or changed records.  Mazévo will add new records, update existing records and disable (or delete if never used) records.  Each record will need to have a unique ID that is passed into the call.  For example, the organization called Basket Weavers Club will always have the same ID, 1001, passed to the call.  

 

API Key

Each Mazévo customer has a unique API key that is used with each call to the API. Please get in touch with Mazévo support to get your API Key.

 

API URL

Contact Mazévo support to obtain the URL for your installation.

API Documentation

 

Examples of passing in data to an API call

 

1) Parameters to return data for all event types and buildings with ids 1 and 3 within the date range.

{

    "start": "2020-11-01T14:00:00-06:00",

    "end": "2020-11-04T15:30:00-06:00",

    "buildingIds": [1,3],

    "eventTypeIds": []

}


 

2) Parameters to return data for all buildings and all event types within the date range:

{

    "start": "2020-11-01T14:00:00-06:00",

    "end": "2020-11-04T15:30:00-06:00",

    "buildingIds": [],

    "eventTypeIds": []

}