This document provides technical details on how the integration between Aeries and Edlink operates, including data mapping, supported models, and important considerations for successful implementation.
How the Integration Works
Edlink's integration with Aeries enables synchronization of roster data, including people, schools, courses, enrollments, and sessions. The integration uses Aeries API endpoints to pull data and transform it into Edlink's internal models. Aeries entities like Students, Courses, and Schools are converted to Edlink objects such as Person, Course, and School through a standardized transformation process.
Entity Mapping
| Aeries Entity | Edlink Model |
|---|---|
| School | School |
| Student | Person (Student role) |
| Staff | Person (Staff role) |
| Course | Course |
| Enrollment | Enrollment |
| Session | Session |
| Period | Period |
| Incident | Incident |
Key Considerations
- SFTP and CSV: Aeries instances using SFTP or CSV uploads will not support real-time sync. These integrations are limited to roster data.
- Enrollment State: Edlink tracks enrollment status by mapping Aeries states (
Active,Inactive,Upcoming, etc.). - Historical Data: Aeries API access may limit data to the current academic year.
Special Accounts and Roles
- Role Mapping:
- Students and staff are mapped as
Personobjects with specific roles assigned (Student,Staff). - Parent or observer accounts are not synced as they are not explicitly exposed through Aeries primary API endpoints.
- Students and staff are mapped as
Recommendations for Common Issues
Solutions for common issues that may arise when integrating with Aeries.
Missing Data (Students/Courses)
- Ensure the Aeries API user has the necessary permissions to access relevant endpoints (
students.read,courses.read, etc.). - Verify that API access is enabled at both the district and school levels.
Incomplete Enrollment Data
- Some enrollments may appear incomplete if associated sessions or sections are missing. Verify that session syncs (
sessions.read) are enabled.
Attendance Discrepancies
- Attendance data sync is optional and may not align with real-time updates. Ensure attendance codes are properly configured in Aeries.
For further assistance, contact Edlink support or your Customer Success Manager.