Help
Enrollment
The currentEnrollment and enrollments properties of the Frame API supply information about the active enrollments of the currently authenticated user by returning an Enrollment object.
Properties
NameTypeMeaning
canConferenceBooleanIndicates whether conferencing is enabled in the course or section for this enrollment.
canEditBooleanIndicates whether the currently authenticated user has rights to edit the course associated with the enrollment.
canReportGradesBooleanIndicates whether the currently authenticated user has rights to report final grades for the section associated with the enrollment.
courseIdStringID of the course associated with the enrollment
courseEnrollmentBooleanIndicates whether this enrollment is a standard enrollment on the course itself instead of a deprecated section enrollment.
courseReferenceStringReference or external identifier of the course associated with the enrollment.
courseRightsNumberRightsFlags of the currently authenticated user on the course.
courseTitleStringTitle of the course associated with the enrollment.
courseTypeStringType of the course associated with the enrollment ("Range" or "Continuous").
courseDaysNumberNumber of days a new enrollment should have for the course associated with the enrollment.
currentUserBooleanIndicates whether this enrollment is for the currently authenticated user.
domainIdStringID of the domain where this enrollment exists.
enrollmentEndStringDate/time string that is the end date/time of the enrollment in the time zone of the currently authenticated user. This string is in the format: yyyy-MM-dd HH:mm:ss.
enrollmentStartStringDate/time string that is the start date/time of the enrollment in the time zone of the currently authenticated user. This string is in the format: yyyy-MM-dd HH:mm:ss.
enrollmentStatusNumberEnrollmentStatus of the enrollment.
idStringID of the enrollment.
isStudentBooleanIndicates whether the currently authenticated user is a student in the section associated with the enrollment.
isTeacherBooleanIndicates whether the currently authenticated user has any teacher rights on the section associated with the enrollment.
isTestStudentBooleanIndicates whether the enrollment is a test student account. This means that another enrollment exists for the currently authenticated user that is a teacher, or author, enrollment on the same entity.
rightsNumberRightsFlags of the currently authenticated user on the enrollment.
sectionIdStringID of the section associated with the enrollment.
sectionReferenceStringReference or external identifier of the section associated with the enrollment.
sectionRightsNumberRightsFlags of the currently authenticated user on the section.
sectionTermStringTerm of the section associated with the enrollment.
sectionTitleStringTitle of the section associated with the enrollment.
userFirstNameStringFirst, or given, name of the user associated with the enrollment.
userIdStringID of the user associated with the enrollment.
userLastNameStringLast, or family, name of the user associated with the enrollment.
See Also
Properties findEnrollment currentenrollmentchanged