openedx / openedx/openedx-platform
Enrollments Management API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
The GET /enrollments endpoint may return large datasets (thousands to hundreds of thousands of entries). Implementation must include pagination and performance optimization.
| Method | Endpoint | Services | Status | Existing API Path | Description |
|---|---|---|---|---|---|
| GET | /api/instructor/v1/courses/{course_key}/enrollments | enrollments, student | Missing | N/A | List all enrollments in the course (supports filtering by username, email) |
| POST | /api/instructor/v1/courses/{course_key}/enrollments | enrollments, student | Partial | /courses/{course_id}/instructor/api/students_update_enrollment | Enroll or unenroll a single student |
| DELETE | /api/instructor/v1/courses/{course_key}/enrollments | enrollments, student | Missing | N/A | Unenroll student(s) specified by query parameters |
| POST | /api/instructor/v1/courses/{course_key}/enrollments/batch | bulk_enroll, bulk_email | Partial | /courses/{course_id}/instructor/api/register_and_enroll_students | Bulk enroll/unenroll students (auto-register if needed, send email notification) |
| POST | /api/instructor/v1/courses/{course_key}/enrollments/csv_upload | bulk_enroll, util | Missing | N/A | Upload CSV file to bulk enroll/unenroll students |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the enrollments and student services named in the issue, then compare the listed existing API paths with the missing and partial endpoints. Define the pagination and performance requirements for GET /api/instructor/v1/courses/{course_key}/enrollments before assessing the related enrollment, batch, delete, and CSV-upload operations. Done means the requested enrollment management API is implemented with pagination for large result sets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100