Skip to main content

Course User Section Detail

{
"id": "integer",
"name": "string",
"dripped_at": "string",
"drip_delay": "integer",
"lessons_order": [],
"available_date": "string",
"locked": "boolean",
"num_lessons": "integer",
"num_lessons_completed": "integer",
"lessons": []
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyUnique integer value identifying this section course
namestringtrueread-onlyName of the section course
dripped_atstring(date-time)falseread-onlySections are dripped relative to this date; used only id course type is scheduled
drip_delayintegerfalseread-onlySections are dripped relative to the enrollment date of the current user; used only if course type is structured .
Default: 0 days; it means the section will be immediately available after joining a course
lessons_orderlist(integer)falseread-onlyList of all lesson IDs belonging to the current section course; IDs are sorted based on the choice made by the course managers
available_datestring(date-time)¦nullfalseread-onlyDetermines when the current section will be available for the user; the value will be null if the course type is self-paced
lockedbooleanfalseread-onlyDetermines whether the current section is locked for the user based on the section availability strategy; the value will not be considered if the course type is self-paced
num_lessonsintegerfalseread-onlyTotal number of published lessons of the current course section
num_lessons_completedintegerfalseread-onlyNumber of lessons completed by the user in the current course section
lessonslist(Course User Lesson Detail)falseread-onlyThe lessons associated to the course section