For Developers
Implementation Details
Limitations
The SFTP (with OneRoster) integration is the preferred method for syncing data between SMS and other systems. The SMS API integration has a more limited data set available from SMS.
Please use the SFTP methods whenever possible to ensure the richest data set is available for syncing.
Entity Mapping
| Skyward Entity | Edlink Entity |
|---|---|
| Entity | School |
| GradingBucket | Session |
| Course | Course |
| Staff | Person |
| Class | Class |
| Student | Person |
| StudentSchedule | Enrollment |
| DisciplineOffense | Incident |
| Guardian | Person, Agent |
| AttendanceByDate | Attendance, Day, Meeting |
| AttendanceByPeriod | Attendance, Period, Day, Meeting |
| OneRoster Entity | Edlink Entity |
|---|---|
| Category | Category |
| LineItem | Assignment |
| Result | Submission |
Notes
- There is some support for historical data using an SFTP CSV sync.
- There can be multiple rows for a single staff member. We merge the rows and combine their schools ids and assign as
active=trueif they are active at any school - We attempt to de-duplicate Periods during syncing, since Skyward can report them multiple times.
Custom Field Mapping
The following fields can be custom-mapped in our dashboard UI:
- agent relationships
- grade levels