Skip to main content

Course User Dashboard

{
"id": "integer",
"username": "string",
"real_name": "string",
"avatar": "string",
"join_status": "string",
"user_completion_rate": "integer",
"last_active_at": "string",
"joined_at": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyA unique integer value identifying this user
usernamestringfalseread-onlyThe username of the user. Max 255 characters. Letters, numbers and -/_ characters
real_namestringfalseread-onlyReal name. Max 255 characters
avatarstring(binary)¦nullfalseread-onlyThe user avatar
join_statusstatusfalseread-onlyEnum to define the course subscription status of the current user
user_completion_rateintegerfalseread-onlyProgress completion of the course in percentage for the current user
last_active_atstring(date-time)falseread-onlyThe datetime when the user completed a lesson in the course
joined_atstring(date-time)falseread-onlyThe datetime when the user joined the course

Enumerated Values

PropertyValueDescription
join_statusnullThe user has no status
join_statusjoinedThe user joined the course
join_statusinvitedThe user was invited to the course
join_statusrequestedThe user requests access to the course (available when the course is closed)
join_statusmanagerThe user is a manager of the course and of course the user joined the course