Response

Response

The distribution response should now appear as follows:

{
"content":
{
"id": 33484,
"rootAsset": {
"dtype": "Course",
"id": 186,
"title": "Test - E-Learnings - No. 2",
"description": "Lorem ipsum dolor sit amet",
...
},
"tags": [],
"groups": [
"group1",
"group2"
],
"assetOwner": {
"dtype": "User",
"userId": "vestibulum.ut.eros@pede.org",
"loginId": "vestibulum.ut.eros@pede.org",
"subject": null,
"title": "Mrs.",
"firstname": "Hilda",
"lastname": "Moody",
"email": "vestibulum.ut.eros@pede.org",
"state": "ACTIVE",
"tags": [],
"roles": [
"LEARNER"
],
"attributes": []
},
"distribution": {
"dtype": "Registration",
"id": 41970,
"automated": false,
"assignment": {
"id": 39961,
"invitedAt": "2021-12-13T11:10:42.859522Z",
"firstAccessedAt": null,
"lastAccessedAt": null,
"completedAt": null,
"completionAmount": null,
"completionState": "NOT_STARTED", <------ CURRENT STATUS
"startedCourseVersionNumber": null,
"startable": true,
"parentContentId": 290
},
"assignmentHistory": [
{
"id": 39961,
"invitedAt": "2024-02-02T11:10:42.859522Z",
"firstAccessedAt": null,
"lastAccessedAt": null,
"completedAt": null, <------ HISTORY STATUS
"completionAmount": null,
"completionState": "NOT_STARTED", <------ HISTORY STATUS
"startedCourseVersionNumber": null,
"startable": true,
"parentContentId": 290
},
{
"id": 491777,
"invitedAt": "2023-01-05T08:00:03.763518Z",
"firstAccessedAt": "2023-01-31T13:12:54Z",
"lastAccessedAt": "2023-01-31T13:29:38Z",
"completedAt": "2023-01-31T13:29:37Z", <------ HISTORY STATUS
"completionAmount": 1,
"completionState": "COMPLETED", <------ HISTORY STATUS
"startedCourseVersionNumber": 2,
"startable": true,
"parentContentId": 459
}
],
"subAssignments": []
},
"attachments": [
...
],
"parentContentId": 290, <---- content_id
"hasCertificate": true,
"certificateEditable": true,
"displayCompletionTime": true,
"displayCompletionTimeEditable": true,
"isSubContent": false,
"secondaryParentContent": null
},
"page": {
"size": 2000,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}

The information about the progress of a course can be found within the distribution object. The assignment object provides information about the current status of a course. In the assignmentHistory object, we obtain information about when and how often the learner has completed the course. Therefore, if we want to check whether a learner has completed the course at any point, we need to examine the assignmentHistory object.

The following completion states are available:: NOT_STARTEDIN_PROGRESSPENDINGDECLINEDCOMPLETED

Progress States

There are three different types of courses that can have different progress states: LearningPath , CoursesLiveEvent.

StateAvailableDescription
NOT_STARTEDCourses, LearningPathCourse has not started yet
IN_PROGRESSCourses, LearningPathCourse has been started
PENDINGLiveEventEvent has not started yet
DECLINEDLiveEventEvent was not accepted
COMPLETEDCourses, LearningPath, LiveEventCourse was passed