Skip to content

Exposes API to add course team member in Studio.

License

Notifications You must be signed in to change notification settings

ibm-skills-network/edx-course-team-api

Repository files navigation

edx_course_team_api

Exposes API to add course team member in Studio.

Usage

Base Url

${STUDIO_URL}/sn-api

Add course team member

POST /course-team/<course_key>/modify_access

The JSON body requires two parameters.

  • email: An existed user.
  • role: One of staff, instructor.

Sample request

{
    "email": "instructor@example.com",
    "role": "instructor"
}

Sample response

{
    "message": "User is added to course-v1:IBMDeveloperSkillsNetwork+CB0103EN+v1333."
}

Remove course team member

DELETE /course-team/<course_key>/modify_access

The JSON body requires one paramter.

  • email: An existed user.

Sample request

{
    "email": "instructor@example.com",
}

Sample response

{
    "message": "User is removed from course-v1:IBMDeveloperSkillsNetwork+CB0103EN+v1333."
}

Implementation

The handler is taken from edx/edx-platform/cms/djangoapps/contentstore/views/user.py.