Enrollments API - Actions

[tonybusa]

The Membership view is being split into 2 screens - Enrollments and Course Team. The Enrollments screen displays 2 tables and has actions that will update those tables. This sub-issue will focus on the endpoints that will enable those actions.

See: https://github.com/openedx/frontend-app-instruct/issues/28

Enrollments and Beta Testers Actions:

Looking at the existing endpoints it appears we can do bulk enroll/unenroll students AND/OR beta testers by comma delimiting the email addresses or usernames in the form with the following requests:

1. POST /courses/{course_id}/instructor/api/students_update_enrollment
2. POST /courses/{course_id}/instructor/api/bulk_beta_modify_access

Both requests use a url-encoded payload of action=enroll/unenroll, [email protected],[email protected], auto_enroll=true/false & email_students=true/false

Not Covered:

1. Check enrollment status - POST
   • validation: email format, empty input
   • payload: learner email address or username
   • response:
     • isEnrolled return learner status: ["active", "inactive", "unenrolled"]
     • notEnrolled return message: "Enrollment status for {username}: never enrolled"

Required Auth:

• roles with All permissions: [staff, admin]
• roles with View permissions: [limited staff, course data researcher]

Image referenced from Epic - Tab Content: Enrollments but updates may be better reflected from the Redesign Figma