For Developers

Implementation Details

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 are converted to Edlink objects through a standardized transformation process.

Entity Mapping

Aeries EntityEdlink Model
SchoolDistrict
SchoolSchool
StudentPerson (Student role)
StaffPerson (Staff role)
CourseCourse
SectionClass
EnrollmentEnrollment
DatabaseYearSession
PeriodPeriod
IncidentIncident
ContentSubcategoryCodeSubject
DepartmentCodeDepartment
  • District: A special school serves as the district for Aeries.
  • People: Students, teachers, and staff are synced from Aeries to Edlink's data model.
  • Classes: Class schedules and sections are mapped directly to Edlink classes.
  • Enrollments: Student and staff enrollments are dynamically updated based on class association.

Additional Notes

  • 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.
  • Role Mapping:
    • Students and staff are mapped as Person objects with specific roles assigned (Student, Staff).
    • Parent or observer accounts are not synced as they are not explicitly exposed through Aeries primary API endpoints.