Course User Lesson Detail
{
"id": "integer",
"name": "string",
"type": "string",
"status": "string",
"comments_enabled": "boolean",
"completion_status": "string",
"locked": "boolean"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | Unique integer value identifying this lesson course |
| name | string | true | read-only | Name of the lesson course |
| type | type | true | read-only | Enum to define the course lesson type |
| status | status | false | read-only | Enum to define the course lesson status. Default: draft |
| comments_enabled | boolean | false | read-only | Enable the comments on the current lesson; if enabled, the users can comment the current lesson. Default: true |
| completion_status | completion_status | false | read-only | Enum to define the course lesson completion status for the user |
| locked | boolean | false | read-only | Determines whether the current lesson is locked for the user based on the user and on the course property: type and enforce_lessons_order |
Enumerated Values
| Property | Value | Description |
|---|---|---|
| type | lesson | Lesson course of type lesson |
| type | quiz | Lesson course of type quiz |
| status | draft | Lesson course status is draft (not yet published for all the users that joined the course) |
| status | published | Lesson course status is published |
| completion_status | uncompleted | Lesson course completion status is uncompleted for the user |
| completion_status | completed | Lesson course completion status is completed for the user |
| completion_status | failed | Lesson course completion status is failed for the user |