For Developers
Implementation Details
This document provides technical details about the integration between Illuminate Education and Edlink. Additionally, this document includes recommendations for addressing common issues during implementation.
Entity Mapping
Below is a table that represents the mapping of entities between Edlink and Illuminate Education:
Edlink | Illuminate Education |
---|---|
District | Site |
School | Site |
Courses | Courses |
Classes | Sections |
People | Users |
People | Students |
Enrollments | Enrollments |
Agents | Contacts |
Sessions | Terms |
People.roles | Roles |
Recommendations for Common Issues
Missing Agents
- Cause: Illuminate's data import process occasionally provides contact records with missing or null relationship fields, which is not supported in Edlink.
- Resolution: These contacts are automatically filtered out during the import process. To resolve this issue, ensure that all contact records have valid relationships.
Incomplete Rosters
- Cause: Missing user identifiers or incomplete metadata can lead to partial data sync.
- Resolution: Ensure that all entities in Illuminate have unique identifiers and sufficient permissions are granted via API credentials.
API Connectivity Issues
- Cause: Rate limits or misconfigured credentials can disrupt syncs.
- Resolution: Monitor API usage, validate credentials, and retry syncs after addressing connectivity issues.