For Developers

Implementation Details

Edlink's integration with Illuminate Education uses their web API to synchronize rostering data, and to manage coursework and grades.

Data Mapping Notes

Sites

Every School is represented as a "site." A district site serves as the parent entity for schools within the district.

Academic Years

Academic years are stored using the ending portion of the year. For example, the "2013-2014" school year is stored as academic year "2014."

Sessions

Each site has at least one Session for a given academic year. Sites may have both "normal" and "summer" sessions.

Limitations

Assignments list

Typically our /assignments listing endpoints are limited on a per-class basis. However the Illuminate Education API does not support filtering, so our list endpoint will actually list all assignments for all classes in the system. Individual classes will have to be checked for connection to which class they are related to.

Contacts with null relationship

Illuminate sometimes gives us contacts that have a null relationship field. We ignore these contacts.

Placeholder Class

Our system requires at least one Class to exist. If Illuminate returns no classes, we create a single placeholder class to ensure our features remain functional.