Serializers

This module contains the model serializers, see Serializing Django objects.

Alternative Word Serializer

class lunes_cms.api.v1.serializers.alternative_word_serializer.AlternativeWordSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the AlternativeWord module. Inherits from serializers.ModelSerializer.

Discipline Serializer

class lunes_cms.api.v1.serializers.discipline_serializer.DisciplineSerializer(*args, **kwargs)

Bases: FallbackIconSerializer

Serializer for the Discipline module. Inherits from FallbackIconSerializer.

get_total_discipline_children(obj)

Returns the total child count by calling utils.get_child_count(obj).

Parameters:: disc (Discipline) – Discipline instance
Returns:: sum of children
Return type:: int

Document Image List Serializer

class lunes_cms.api.v1.serializers.document_image_list_serializer.DocumentImageListSerializer(*args, **kwargs)

Bases: ListSerializer

List Serializer for the DocumentImage module. Inherits from serializers.ListSerializer.

to_representation(data)

Overwrite django built-in function to only deliver approved images.

Parameters:: data (models.Model) – model instance
Returns:: serialized model data
Return type:: dict

update(instance, validated_data)

Document Image Serializer

class lunes_cms.api.v1.serializers.document_image_serializer.DocumentImageSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the DocumentImage module. Inherits from serializers.ModelSerializer.

Document Serializer

class lunes_cms.api.v1.serializers.document_serializer.DocumentSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the Document module. Inherits from serializers.ModelSerializer.

Fallback Icon Serializer

class lunes_cms.api.v1.serializers.fallback_icon_serializer.FallbackIconSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for models with an icon field which should provide a fallback value

get_icon(obj)

Get the the icon if it exists and a fallback image otherwise

Parameters:: obj (Model) – The model instance
Returns:: The url to the icon
Return type:: str

Feedback Serializer

class lunes_cms.api.v1.serializers.feedback_serializer.FeedbackSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the Feedback module. Inherits from ‘serializers.ModelSerializer’.

validate(attrs)

Group Serializer

class lunes_cms.api.v1.serializers.group_serializer.GroupSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the Group module. Inherits from serializers.ModelSerializer.

get_total_discipline_children(obj)

Returns the total child count of a group. A child itself or one of its sub-children needs to contain at least one training set.

Parameters:: disc (Discipline) – Discipline instance
Returns:: sum of children
Return type:: int

Sponsor Serializer

class lunes_cms.api.v1.serializers.sponsor_serializer.SponsorSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for the Sponsor module.

Training Set Serializer

class lunes_cms.api.v1.serializers.training_set_serializer.TrainingSetSerializer(*args, **kwargs)

Bases: FallbackIconSerializer

Serializer for the TrainingSet module. Inherits from FallbackIconSerializer.