openedx.core.djangoapps.course_groups.rest_api package

openedx.core.djangoapps.course_groups.rest_api package#

Serializers for content group configurations REST API.

class openedx.core.djangoapps.course_groups.rest_api.serializers.ContentGroupConfigurationSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for a content group configuration (UserPartition with scheme=’cohort’).

class openedx.core.djangoapps.course_groups.rest_api.serializers.ContentGroupsListResponseSerializer(*args, **kwargs)#

Bases: Serializer

Response serializer for listing all content groups.

Returns the content group configuration ID, a flat list of content groups, and a link to Studio where instructors can manage content groups.

class openedx.core.djangoapps.course_groups.rest_api.serializers.GroupSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for a single group within a content group configuration.

Content Groups REST API v2 URLs

REST API views for content group configurations.

class openedx.core.djangoapps.course_groups.rest_api.views.GroupConfigurationDetailView(**kwargs)#

API view for retrieving a specific content group configuration.

get(request, course_id, configuration_id)#: Retrieve a specific content group configuration.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>, <class 'lms.djangoapps.instructor.permissions.InstructorPermission'>)#

class openedx.core.djangoapps.course_groups.rest_api.views.GroupConfigurationsListView(**kwargs)#

API view for listing content group configurations.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>, <class 'lms.djangoapps.instructor.permissions.InstructorPermission'>)#