Some of the Aeries OneRoster API endpoints may return large amounts of data, and excessive “get all” requests can have a negative impact on Aeries performance for end users and other vendors. Therefore, Aeries urges customers and vendors to be mutually responsible for establishing and adhering to best practices in the use of the Aeries OneRoster API.
Below are a few of our recommendations.
- Perform full data syncs outside of peak operating hours
- Use the filter parameter with the dateLastModified field to perform differential syncs, thus eliminating the need to perform full syncs as frequently
- Use the pagination support (limit and offset parameters) to break up large data sets into smaller chunks
- If only a few fields are required by the application, use the fields parameter to limit the response to only the fields that are needed
Documentation of the above-mentioned parameters (e.g., filter, limit, offset, and fields) is available in the OneRoster 1.1 specification.