Overview
The FileMaker API is part of the Claris FileMaker platform that Music Monitor is built on. Importantly, the FileMaker API is designed to be agnostic of the database schema. That's why it uses layouts as endpoints - so it can dynamically collect the called data based on a layout's context and constituent fields.
The layouts are very quick, easy, and low-impact for the Music Monitor team to adjust. So please do ask away if there's any data sets you'd find particularly useful (even if they are variants of what we already have available). This is also why our documentation doesn't cover the specific layouts, only the generic calls - we've not settled on any particular configurations.
Tip: For more information on the layouts, you're best off making some Get Records calls to each of the layouts so you can discover what's included.
Setup
Here is everything you will need to get started:
FileMaker Data API Documentation
You will use standard REST API calls to interact with our system. For the official documentation specific to your server, we will refer you to a FileMaker Data API Guide location.
Data Layouts (Endpoints)
In FileMaker, all data is accessed via specific layouts within the MMAPI file. We have pre-configured a comprehensive set of layouts for you to pull data from:
Accounts
Attendance
CalendarEntries (This layout also includes scheduled sessions data)
CalendarExclusions
Contacts
EnrolmentsALL
EnsembleAttendance
EnsembleCodes
Ensembles
Students
Tuition
Subjects
Note: It is easy for us to add fields to existing layouts or create new ones, so we can fine-tune access as you explore the data.
Key Requirements & Troubleshooting
Based on past setups, here are a few things to keep in mind:
API Service: We will enable the Data API service on the server for you as part of the setup. If this ever drops out on our end, you will encounter a 502 Bad Gateway error.
Authentication: If you encounter a 401 (Unauthorised) error, it may indicate a deactivated account or an issue with your password. Please let us know if this happens and we can reset the credentials or restart the FileMaker Service on our end.