lms.djangoapps.support.rest_api package

Subpackages

• lms.djangoapps.support.rest_api.v1 package
  • Submodules
  • lms.djangoapps.support.rest_api.v1.urls module
  • lms.djangoapps.support.rest_api.v1.views module
    • CourseTeamManageAPIView
      • CourseTeamManageAPIView.get()
      • CourseTeamManageAPIView.get_accessible_courses_for_user()
      • CourseTeamManageAPIView.get_course_role_map_for_user()
      • CourseTeamManageAPIView.get_queryset()
      • CourseTeamManageAPIView.get_serializer_context()
      • CourseTeamManageAPIView.list()
      • CourseTeamManageAPIView.openapi
      • CourseTeamManageAPIView.pagination_class
      • CourseTeamManageAPIView.permission_classes
      • CourseTeamManageAPIView.put()
      • CourseTeamManageAPIView.serializer_class
      • CourseTeamManageAPIView.swagger_auto_schema()
  • Module contents

Submodules

lms.djangoapps.support.rest_api.serializers module

Serializers for use in the support app.

class lms.djangoapps.support.rest_api.serializers.CourseTeamManageSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for course team management context data

class Meta

Bases: object

fields = ('id', 'display_name', 'role', 'status', 'course_url')

model

alias of CourseOverview

get_course_url(obj)

Construct the course URL for CMS with proper scheme and host.

get_role(obj)

get_status(obj)

Determine if the course is active or archived based on end date. Returns ‘active’ if course end is null or in the future, ‘archived’ otherwise.

to_representation(instance)

Object instance -> Dict of primitive datatypes.

lms.djangoapps.support.rest_api.urls module

URL definitions for the support API.

Module contents