A Role describes a Person's role or duty
within a Class or District.
The values you will receive from our API depend heavily on the type
of provider you're using. For instance, few providers will support the aide type.
The values of this enum are of type string.
Values
| Value | Description |
|---|---|
student | A student. |
district-administrator | A district-level administrator. |
administrator | A school-level administrator. |
teacher | A teacher. |
staff | A staff member (not necessarily a teacher). |
observer | Someone who is observing the class, but not participating. |
parent | A parent. |
guardian | A guardian. |
ta†| A teaching assistant or grader. |
aide†| Someone who provides assistance to a student, such as a sign language interpreter. |
designer†| Someone who can create or modify class content within the source system. |
member†‡ | A generic type for when we cannot resolve a proper role for a given person. |
†These values are uncommon.‡ The most common case this can occur is when the school defines their own role types which do not map back to any standard roles. Some systems such as Blackboard also support a role type just called member, so those users will have the member role as well.
OneRoster Role Mappings
Integrations made with a OneRoster-compatible source will be mapped to Edlink roles according to this table.
| OneRoster Role | Edlink Role |
|---|---|
administrator | administrator |
aide | aide |
guardian | guardian |
invigilator | teacher |
parent | parent |
proctor | teacher |
relative | guardian |
student | student |
teacher | teacher |