GET api/Rest/v1/users/{UserId}/enrollments/{CourseId}/sessions?Status={Status}&ModifiedSince={ModifiedSince}
List user's session enrollments.
Requires Authorization
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId |
The user ID. |
globally unique identifier |
None. |
courseId |
The course ID. |
globally unique identifier |
None. |
status |
The enrollment status. |
Status |
None. |
modifiedSince |
The last modified date and time. |
date |
None. |
userId | string |
None. |
|
courseId | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of SessionEnrollmentModelName | Description | Type | Additional information |
---|---|---|---|
SessionId | globally unique identifier |
None. |
|
Id | globally unique identifier |
None. |
|
CourseEnrollmentId | globally unique identifier |
None. |
|
ChapterId | globally unique identifier |
None. |
|
SessionId | globally unique identifier |
None. |
|
LessonId | globally unique identifier |
None. |
|
Name | string |
None. |
|
UserId | globally unique identifier |
None. |
|
FullName | string |
None. |
|
Status | Status |
None. |
|
Progress | decimal number |
None. |
|
Score | decimal number |
None. |
|
TimeSpent |
represented as a . |
time interval |
None. |
DateEnrolled | date |
None. |
|
DateStarted | date |
None. |
|
DateCompleted | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "SessionId": "ff763a0e-b271-4f36-9129-5e583991e798", "Id": "b4902c17-b429-4a01-8d0f-fdfcc6168b2f", "CourseEnrollmentId": "0f4988f9-4003-4ded-953f-74e617829dcc", "ChapterId": "6d5d9795-cd3c-4cac-8e65-82e08836797c", "LessonId": "023e3228-7915-4e9b-945b-24d36120aed0", "Name": "sample string 4", "UserId": "8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94", "FullName": "sample string 6", "Status": 0, "Progress": 7.0, "Score": 1.0, "TimeSpent": "00:00:00.0000008", "DateEnrolled": "2024-05-30T10:16:17.807", "DateStarted": "2024-05-30T10:16:17.807", "DateCompleted": "2024-05-30T10:16:17.807" }, { "SessionId": "ff763a0e-b271-4f36-9129-5e583991e798", "Id": "b4902c17-b429-4a01-8d0f-fdfcc6168b2f", "CourseEnrollmentId": "0f4988f9-4003-4ded-953f-74e617829dcc", "ChapterId": "6d5d9795-cd3c-4cac-8e65-82e08836797c", "LessonId": "023e3228-7915-4e9b-945b-24d36120aed0", "Name": "sample string 4", "UserId": "8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94", "FullName": "sample string 6", "Status": 0, "Progress": 7.0, "Score": 1.0, "TimeSpent": "00:00:00.0000008", "DateEnrolled": "2024-05-30T10:16:17.807", "DateStarted": "2024-05-30T10:16:17.807", "DateCompleted": "2024-05-30T10:16:17.807" } ]
text/html
Sample:
[{"SessionId":"ff763a0e-b271-4f36-9129-5e583991e798","Id":"b4902c17-b429-4a01-8d0f-fdfcc6168b2f","CourseEnrollmentId":"0f4988f9-4003-4ded-953f-74e617829dcc","ChapterId":"6d5d9795-cd3c-4cac-8e65-82e08836797c","LessonId":"023e3228-7915-4e9b-945b-24d36120aed0","Name":"sample string 4","UserId":"8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94","FullName":"sample string 6","Status":0,"Progress":7.0,"Score":1.0,"TimeSpent":"00:00:00.0000008","DateEnrolled":"2024-05-30T10:16:17.807","DateStarted":"2024-05-30T10:16:17.807","DateCompleted":"2024-05-30T10:16:17.807"},{"SessionId":"ff763a0e-b271-4f36-9129-5e583991e798","Id":"b4902c17-b429-4a01-8d0f-fdfcc6168b2f","CourseEnrollmentId":"0f4988f9-4003-4ded-953f-74e617829dcc","ChapterId":"6d5d9795-cd3c-4cac-8e65-82e08836797c","LessonId":"023e3228-7915-4e9b-945b-24d36120aed0","Name":"sample string 4","UserId":"8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94","FullName":"sample string 6","Status":0,"Progress":7.0,"Score":1.0,"TimeSpent":"00:00:00.0000008","DateEnrolled":"2024-05-30T10:16:17.807","DateStarted":"2024-05-30T10:16:17.807","DateCompleted":"2024-05-30T10:16:17.807"}]
application/xml, text/xml
Sample:
<ArrayOfSessionEnrollmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbsorbLMS.Absorb.Controllers.Api.Rest.v1.Models"> <SessionEnrollmentModel> <ChapterId>6d5d9795-cd3c-4cac-8e65-82e08836797c</ChapterId> <CourseEnrollmentId>0f4988f9-4003-4ded-953f-74e617829dcc</CourseEnrollmentId> <DateCompleted>2024-05-30T10:16:17.807</DateCompleted> <DateEnrolled>2024-05-30T10:16:17.807</DateEnrolled> <DateStarted>2024-05-30T10:16:17.807</DateStarted> <FullName>sample string 6</FullName> <Id>b4902c17-b429-4a01-8d0f-fdfcc6168b2f</Id> <LessonId>023e3228-7915-4e9b-945b-24d36120aed0</LessonId> <Name>sample string 4</Name> <Progress>7</Progress> <Score>1</Score> <SessionId>9ef965c2-fd08-462a-a22f-c04940d5829f</SessionId> <Status>NotStarted</Status> <TimeSpentTicks>8</TimeSpentTicks> <UserId>8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94</UserId> <SessionId>ff763a0e-b271-4f36-9129-5e583991e798</SessionId> </SessionEnrollmentModel> <SessionEnrollmentModel> <ChapterId>6d5d9795-cd3c-4cac-8e65-82e08836797c</ChapterId> <CourseEnrollmentId>0f4988f9-4003-4ded-953f-74e617829dcc</CourseEnrollmentId> <DateCompleted>2024-05-30T10:16:17.807</DateCompleted> <DateEnrolled>2024-05-30T10:16:17.807</DateEnrolled> <DateStarted>2024-05-30T10:16:17.807</DateStarted> <FullName>sample string 6</FullName> <Id>b4902c17-b429-4a01-8d0f-fdfcc6168b2f</Id> <LessonId>023e3228-7915-4e9b-945b-24d36120aed0</LessonId> <Name>sample string 4</Name> <Progress>7</Progress> <Score>1</Score> <SessionId>9ef965c2-fd08-462a-a22f-c04940d5829f</SessionId> <Status>NotStarted</Status> <TimeSpentTicks>8</TimeSpentTicks> <UserId>8c6e27fc-6ad7-49c3-a551-3ee7fcb53a94</UserId> <SessionId>ff763a0e-b271-4f36-9129-5e583991e798</SessionId> </SessionEnrollmentModel> </ArrayOfSessionEnrollmentModel>