edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

Enrollments API - Lists

Open tonybusa opened this issue 2 months ago • 0 comments

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 displaying the lists for those tables and allowing for search functionality and pagination for those lists.

  1. List all enrollments (learners / students)
  2. List all beta testers
    • existing endpoint POST /courses/{course_id}instructor/api/list_course_role_members will return an object containing the list of rolename for a specific course:
{
        "course_id": "some/course/id",
        "staff": [
            {
                "username": "staff1",
                "email": "[email protected]",
                "first_name": "Joe",
                "last_name": "Shmoe",
            }
        ]
    }

where staff in the above can be any rolename of ['instructor', 'staff', 'beta', 'ccx_coach'] which is included in the request payload. In our case, we want to send rolename=beta.

  • Currently this API does not support search or pagination.

Image below referenced from: https://github.com/openedx/frontend-app-instruct/issues/10

Image

tonybusa avatar Oct 23 '25 19:10 tonybusa