Skip to main content

Course Lesson

{
"id": "integer",
"name": "string",
"type": "string",
"status": "string",
"comments_enabled": "boolean",
"html": "string",
"created_at": "string",
"created_by": {},
"medias": []
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyUnique integer value identifying this lesson course
namestringtruenoneName of the lesson course
typetypetruenoneEnum to define the course lesson type
statusstatusfalsenoneEnum to define the course lesson status.
Default: draft
comments_enabledbooleanfalsenoneEnable the comments on the current lesson; if enabled, the users can comment the current lesson.
Default: true
textstringfalsewrite-onlyThe lesson course text.
Default: empty string.
Only available when creating or updating a lesson course
htmlstringfalseread-onlyThe lesson course text.
>Only available when getting a lesson course
created_atstring(date-time)falseread-onlyDatetime of lesson course creation
created_byUserfalseread-onlyThe lesson course creator
mediaslist(integer)falsenoneList of id of Media for the lesson course

Enumerated Values

PropertyValueDescription
typelessonLesson course of type lesson
typequizLesson course of type quiz
statusdraftLesson course status is draft (not yet published for all the users that joined the course)
statuspublishedLesson course status is published