Views

Discipline Filtered Viewset

class lunes_cms.api.v1.views.discipline_filtered_viewset.DisciplineFilteredViewSet(**kwargs)

Bases: ListModelMixin, GenericViewSet

Defines a view set for the Discipline module, optionally filtered respected to the different mptt levels or a group id. If no discipline id is given, all root elements will be displayed. Inherits from viewsets.ModelViewSet and defines queryset and serializers.

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the DisciplineViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

name = None

queryset = TreeQuerySet

serializer_class: alias of DisciplineSerializer

suffix = None

Discipline Viewset

class lunes_cms.api.v1.views.discipline_viewset.DisciplineViewSet(**kwargs)

Bases: ModelViewSet

Retrieve disciplines, either all global disciplines or filtered by the given API key. Get a single record by appending the id of the requested discipline.

basename = None

description = None

detail = None

get_queryset()

Get the queryset of disciplines - either those created by admins or by the group of the given key

Returns:: The queryset of disciplines
Return type:: QuerySet

http_method_names = ['get']

name = None

serializer_class: alias of DisciplineSerializer

suffix = None

Document By Id Viewset

class lunes_cms.api.v1.views.document_by_id_viewset.DocumentByIdViewSet(**kwargs)

Bases: ModelViewSet

Defines a view set for the Document module of a given id. Inherits from viewsets.ModelViewSet and defines queryset and serializers.

authentication_classes = [<class 'rest_framework.authentication.SessionAuthentication'>, <class 'rest_framework.authentication.BasicAuthentication'>]

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the DocumentViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

http_method_names = ['get']

name = None

permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>]

serializer_class: alias of DocumentSerializer

suffix = None

Document Viewset

class lunes_cms.api.v1.views.document_viewset.DocumentViewSet(**kwargs)

Bases: ModelViewSet

List of available documents. A document is an item to be learned and consists of an image, multiple correct answers, and other details. If training set ID is provided as a parameter, the list will return only documents belonging to the training set. A valid API-Key may be required.

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the DocumentViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

http_method_names = ['get']

name = None

serializer_class: alias of DocumentSerializer

suffix = None

Feedback Viewset

class lunes_cms.api.v1.views.feedback_viewset.CreateFeedbackViewSet(**kwargs)

Bases: CreateModelMixin, GenericViewSet

A viewset that provides only the create action for feedback elements.

basename = None

description = None

detail = None

name = None

serializer_class: alias of FeedbackSerializer

suffix = None

Group Viewset

class lunes_cms.api.v1.views.group_viewset.GroupViewSet(**kwargs)

Bases: ModelViewSet

List available information of a user group. A valid API-Key is required. There is no need to pass a group id or similar, the returned queryset is filtered by the delivered API-Key.

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the GroupViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

http_method_names = ['get']

name = None

permission_classes = [<class 'lunes_cms.api.permissions.VerifyGroupKey'>]

serializer_class: alias of GroupSerializer

suffix = None

Sponsors Viewset

class lunes_cms.api.v1.views.sponsors_viewset.SponsorsViewSet(**kwargs)

Bases: ModelViewSet

View to provide a queryset of all current sponsors in the app.

basename = None

description = None

detail = None

get_queryset()

Get the queryset of the current sponsors managed by the cms.

Returns:: The queryset of disciplines
Return type:: QuerySet

http_method_names = ['get']

name = None

serializer_class: alias of SponsorSerializer

suffix = None

Training Set By Id Viewset

class lunes_cms.api.v1.views.training_set_by_id_viewset.TrainingSetByIdViewSet(**kwargs)

Bases: ReadOnlyModelViewSet

Defines a view set for a TrainingSet module of a given id. Inherits from viewsets.ReadOnlyModelViewSet and defines queryset and serializers.

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the TrainingSetViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

name = None

serializer_class: alias of TrainingSetSerializer

suffix = None

Training Set Viewset

class lunes_cms.api.v1.views.training_set_viewset.TrainingSetViewSet(**kwargs)

Bases: ModelViewSet

List training sets. If discipline ID is provided as a parameter, the list will return only training sets belonging to the discipline. A valid API-Key may be required.

basename = None

description = None

detail = None

get_queryset()

Defining custom queryset

Parameters:: self (class) – A handle to the TrainingSetViewSet
Returns:: (filtered) queryset
Return type:: QuerySet

http_method_names = ['get']

name = None

serializer_class: alias of TrainingSetSerializer

suffix = None

Word Viewset

class lunes_cms.api.v1.views.word_viewset.WordViewSet(**kwargs)

Bases: ModelViewSet

Retrieve the list of all default words/documents or get a single record by appending the id of the requested word.

authentication_classes = [<class 'rest_framework.authentication.SessionAuthentication'>, <class 'rest_framework.authentication.BasicAuthentication'>]

basename = None

description = None

detail = None

get_queryset()

Get the queryset of words/documents

Returns:: The queryset of words
Return type:: QuerySet

http_method_names = ['get']

name = None

serializer_class: alias of DocumentSerializer

suffix = None