For Developers

Person Role

This enumeration is part of an upcoming API update which is currently in beta and therefore subject to change.

Person Role describes a Person's role within an educational context. For class enrollments, a role is assigned directly on role in Enrollments.

Districts may also define their own role codes. District Enrollment Roles, School Enrollment Roles, and Enrollment Roles are code mappings that connect those district codes to the values below, referenced via district_enrollment_role_id, school_enrollment_role_id, and enrollment_role_id on District Enrollments, School Enrollments, and class Enrollments respectively (currently in beta). See Code Mappings for more information.

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

ValueDescription
studentA student.
district-administratorA district-level administrator.
administratorA school-level administrator.
teacherA teacher.
staffA staff member (not necessarily a teacher).
observerSomeone who is observing the class, but not participating.
parentA parent.
guardianA 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.
otherA "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.