This enumeration is part of the v2.5 API update which is currently in beta and therefore subject to change.
A Person Role describes a Person's role or duty for specific District Enrollments, School Enrollments, or Class Enrollments via District Enrollment Roles, School Enrollment Roles, or Class Enrollment Roles respectively.
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. |
other | A "catch-all" for mappings that are ambiguous/unknown. |
†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.