Absorb Integration API (v2)

Download OpenAPI specification:Download

Session Enrollments

List user's session enrollments for specific course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The specified date for filtering enrollments that were edited after this date.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The unique activity enrollment identifier.
sessionId	string <guid> The session ID.
courseEnrollmentId	string <guid> The course enrollment ID.
name	string The activity's name.
userId	string <guid> The user's ID.
fullName	string The user's full name.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment's status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> The user's progress.
score	number <decimal> The user's score.
timeSpent	string <duration> The amount of time the user has spent on the activity.
dateEnrolled	string <date-time> The date of enrollment.
dateStarted	string <date-time> The activity's date started.
dateCompleted	string <date-time> The activity's date completed.
dateEdited	string <date-time> The date the enrollment was last edited.

Response samples

200
404

Content type

application/json

[{"id": "string",
"sessionId": "string",
"courseEnrollmentId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}
]

Get user's session enrollment for specific course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
sessionId required	string <guid> The session ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The specified date for filtering enrollments that were edited after this date.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The unique activity enrollment identifier.
sessionId	string <guid> The session ID.
courseEnrollmentId	string <guid> The course enrollment ID.
name	string The activity's name.
userId	string <guid> The user's ID.
fullName	string The user's full name.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment's status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> The user's progress.
score	number <decimal> The user's score.
timeSpent	string <duration> The amount of time the user has spent on the activity.
dateEnrolled	string <date-time> The date of enrollment.
dateStarted	string <date-time> The activity's date started.
dateCompleted	string <date-time> The activity's date completed.
dateEdited	string <date-time> The date the enrollment was last edited.

Response samples

200
404

Content type

application/json

{"id": "string",
"sessionId": "string",
"courseEnrollmentId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}

Create ILC enrollment for user.

Creates a new ILC enrollment and Session enrollment in the specific ILC course for a specific user. Additionally supports re-enrollment and canceling of an existing session enrollment.

Multi-Session ILCs are not supported.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
sessionId required	string <guid> The session ID.

query Parameters

reEnroll	boolean If true, the user will be re-enrolled in the specified session, false otherwise.
cancelSession	boolean If true, the existing session enrollment will be cancelled, false otherwise.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

userId	string <guid> The user ID.
courseId	string <guid> The instructor led course ID.
sessionId	string <guid> The session ID.
enrollmentId	string <guid> The instructor led course enrollment ID.
sessionEnrollmentId	string <guid> The session enrollment ID.

Response samples

201
400
404
422

Content type

application/json

{"userId": "string",
"courseId": "string",
"sessionId": "string",
"enrollmentId": "string",
"sessionEnrollmentId": "string"
}

List an ILC's session enrollments.

Authorizations:

api_key

path Parameters

courseId required	string <guid> The course ID.
sessionId required	string <guid> The session ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The specified date for filtering enrollments that were edited after this date.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (SessionEnrollmentResource) A collection of SessionEnrollmentResources.

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"enrollments": [{"id": "string",
"sessionId": "string",
"courseEnrollmentId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}
]
}

Chapter Enrollments

List chapter enrollments for a specified course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The unique identifier of the activity enrollment.
courseEnrollmentId	string <guid> The course enrollment ID.
chapterId	string <guid> The chapter ID.
sessionId	string <guid> The session ID.
lessonId	string <guid> The lesson ID.
name	string The name of the activity.
userId	string <guid> The user's ID.
fullName	string The user's full name.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The status of the enrollment. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> The user's progress.
score	number <decimal> The user's score.
timeSpent	string <duration> TimeSpentTicks represented as a TimeSpan.
dateEnrolled	string <date-time> The date of enrollment.
dateStarted	string <date-time> The date started.
dateCompleted	string <date-time> The date completed.
lessonEnrollmentIds	Array of strings <guid> [ items <guid > ] A list of lesson enrollment IDs.

Response samples

200
404

Content type

application/json

[{"id": "string",
"courseEnrollmentId": "string",
"chapterId": "string",
"sessionId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"lessonEnrollmentIds": ["string"
]
}
]

Get chapter enrollment for a specified course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
chapterId required	string <guid> The chapter ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The unique identifier of the activity enrollment.
courseEnrollmentId	string <guid> The course enrollment ID.
chapterId	string <guid> The chapter ID.
sessionId	string <guid> The session ID.
lessonId	string <guid> The lesson ID.
name	string The name of the activity.
userId	string <guid> The user's ID.
fullName	string The user's full name.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The status of the enrollment. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> The user's progress.
score	number <decimal> The user's score.
timeSpent	string <duration> TimeSpentTicks represented as a TimeSpan.
dateEnrolled	string <date-time> The date of enrollment.
dateStarted	string <date-time> The date started.
dateCompleted	string <date-time> The date completed.
lessonEnrollmentIds	Array of strings <guid> [ items <guid > ] A list of lesson enrollment IDs.

Response samples

200
404

Content type

application/json

{"id": "string",
"courseEnrollmentId": "string",
"chapterId": "string",
"sessionId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"lessonEnrollmentIds": ["string"
]
}

Enrollments

Create enrollment for user and course.

Multi-Session ILCs are not supported.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.

query Parameters

reEnroll

boolean

If true, the user will be re-enrolled in the specified course.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

enrollmentId	string <guid> The enrollment ID.
courseId	string <guid> the course ID.
userId	string <guid> The user ID.

Response samples

201
400
404
422

Content type

application/json

{"enrollmentId": "string",
"courseId": "string",
"userId": "string"
}

Get user's enrollment for specific course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user's ID.
courseId required	string <guid> The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
courseId	string <guid> Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
dateEdited	string <date-time> The date enrollment was last edited.
dateAdded	string <date-time> The date the enrollment was added.
fullName	string Learner's full name.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
timeSpentTicks	integer <int64> The length of time the learner has spent in the course (stored as ticks).
timeSpent	string <duration> The length of time the learner has spent in the course.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean Indicates if the enrollment is the current (active) enrollment or a historical enrollment.
dateDue	string <date-time> The date enrollment is due.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
jobTitle	string Learner's job title.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's Id or Curriculum's Id.
avatar	string The display path of a User's Avatar.

Response samples

200
404

Content type

application/json

{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}

Create or update course enrollment.

Multi-Session ILCs are not supported.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user ID.

query Parameters

reEnroll

boolean

If true, the user will be re-enrolled in the specified course.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The model of the data for a course enrollment. Settable properties are Status, DateCompleted, DateExpires, CourseVersionId, AcceptedTermsAndConditions, EnrollmentKeyId, Credits, Score

id	string <guid> Enrollment identifier.
courseId required	string <guid> non-empty Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
fullName	string Learner's full name.
jobTitle	string Learner's job title.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean If true, indicates the enrollment is the current (active) enrollment. false if a historical enrollment.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's ID or Curriculum's ID.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
dateDue	string <date-time> The date the learner must complete the course by.
avatar	string The display path of a User's Avatar.
	Array of objects (CourseEnrollmentCreditsModel) The credits awarded by credit type.

Responses

Response Schema: application/json

enrollmentId	string <guid> The enrollment ID.
courseId	string <guid> the course ID.
userId	string <guid> The user ID.

Request samples

Payload

Content type

application/json

{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"fullName": "string",
"jobTitle": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"courseCollectionId": "string",
"accessDate": "2019-08-24T14:15:22Z",
"dateDue": "2019-08-24T14:15:22Z",
"avatar": "string",
"creditTypeCredits": [{"creditTypeId": "string",
"credits": 0
}
]
}

Response samples

201
400
404
422

Content type

application/json

{"enrollmentId": "string",
"courseId": "string",
"userId": "string"
}

List course enrollments for specific user.

Supports pagination, filtering, and sorting.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user ID.

query Parameters

modifiedSince	string <date-time> (Deprecated) The specified date for filtering enrollments that were edited after this date.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 (Deprecated) The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (UserCourseEnrollmentResource)

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"enrollments": [{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}
]
}

Un-enroll users from courses.

For types Online Course, ILC, Curriculum or Course Bundle.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The Ids of the enrollments to unenroll users from courses.

Array

string <guid>

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

400
422

Content type

application/json

{"validations": ["string"
],
"code": 0,
"message": "string",
"term": "string",
"_meta": {"property1": "string",
"property2": "string"
}
}

Get course enrollment.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The course enrollment ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
courseId	string <guid> Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
dateEdited	string <date-time> The date enrollment was last edited.
dateAdded	string <date-time> The date the enrollment was added.
fullName	string Learner's full name.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
timeSpentTicks	integer <int64> The length of time the learner has spent in the course (stored as ticks).
timeSpent	string <duration> The length of time the learner has spent in the course.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean Indicates if the enrollment is the current (active) enrollment or a historical enrollment.
dateDue	string <date-time> The date enrollment is due.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
jobTitle	string Learner's job title.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's Id or Curriculum's Id.
avatar	string The display path of a User's Avatar.

Response samples

200
404

Content type

application/json

{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}

List enrollments for specific course.

Supports pagination, filtering, and sorting.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

query Parameters

modifiedSince	string <date-time> (Deprecated) The specified date for filtering enrollments that were edited after this date.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 (Deprecated) The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (CourseEnrollmentResource)

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"enrollments": [{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"fullName": "string",
"jobTitle": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]
}

Get user's enrollment for specific course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user's ID.
courseId required	string <guid> The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
courseId	string <guid> Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
dateEdited	string <date-time> The date enrollment was last edited.
dateAdded	string <date-time> The date the enrollment was added.
fullName	string Learner's full name.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
timeSpentTicks	integer <int64> The length of time the learner has spent in the course (stored as ticks).
timeSpent	string <duration> The length of time the learner has spent in the course.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean Indicates if the enrollment is the current (active) enrollment or a historical enrollment.
dateDue	string <date-time> The date enrollment is due.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
jobTitle	string Learner's job title.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's Id or Curriculum's Id.
avatar	string The display path of a User's Avatar.

Response samples

200
404

Content type

application/json

{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}

List course enrollments for bulk user list.

Authorizations:

api_key

query Parameters

userIds	Array of strings <guid> [ items <guid > ] The user IDs.
courseIds	Array of strings <guid> [ items <guid > ] The course IDs.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> Enrollment identifier.
courseId	string <guid> Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
dateEdited	string <date-time> The date enrollment was last edited.
dateAdded	string <date-time> The date the enrollment was added.
fullName	string Learner's full name.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
timeSpentTicks	integer <int64> The length of time the learner has spent in the course (stored as ticks).
timeSpent	string <duration> The length of time the learner has spent in the course.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean Indicates if the enrollment is the current (active) enrollment or a historical enrollment.
dateDue	string <date-time> The date enrollment is due.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
jobTitle	string Learner's job title.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's Id or Curriculum's Id.
avatar	string The display path of a User's Avatar.

Response samples

200

Content type

application/json

[{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}
]

Lesson Enrollments

Lists enrollments for a lesson.

Authorizations:

api_key

path Parameters

courseId required	string <guid> The course ID.
lessonId required	string <guid> The lesson ID.

query Parameters

modifiedSince	string <date-time> (Deprecated) The specified date for filtering enrollments that were edited after this date.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 (Deprecated) The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (LessonEnrollmentResource) A list of LessonEnrollmentResources.

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"lessonEnrollments": [{"id": "string",
"chapterEnrollmentId": "string",
"type": "string",
"attempts": 0,
"failures": 0,
"lastAttempt": "2019-08-24T14:15:22Z",
"courseEnrollmentId": "string",
"chapterId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]
}

Get lesson enrollment.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
chapterId required	string <guid> The chapter ID.
lessonId required	string <guid> The lesson ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
chapterEnrollmentId	string <guid> The Id of related ChapterEnrollment
type	string The type of ActivityEnrollment
attempts	integer <int32> Number of attempts
failures	integer <int32> Number of failures
lastAttempt	string <date-time> Date of the last attempt
courseEnrollmentId	string <guid> Id of the related CourseEnrollment
chapterId	string <guid> Id of the related Chapter
lessonId	string <guid> Id of the related Lesson
name	string Name of the Lesson Enrollment
userId	string <guid> Id of the related User
fullName	string Full name of the related User
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 Status of the Enrollment Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> Progress of this enrollment
score	number <decimal> Score of this enrollment
timeSpent	string <duration> The length of time the learner has spent in the course.
dateEnrolled	string <date-time> Date the User was enrolled
dateStarted	string <date-time> Date the User started.
dateCompleted	string <date-time> Date the user completed.
dateEdited	string <date-time> The last date edited.
dateAdded	string <date-time> The date the enrollment was added.

US

https://rest.myabsorb.com/users/{userId}/enrollments/{courseId}/chapters/{chapterId}/lessons/{lessonId}

CA

https://rest.myabsorb.ca/users/{userId}/enrollments/{courseId}/chapters/{chapterId}/lessons/{lessonId}

EU

https://rest.myabsorb.eu/users/{userId}/enrollments/{courseId}/chapters/{chapterId}/lessons/{lessonId}

AU

https://rest.myabsorb.com.au/users/{userId}/enrollments/{courseId}/chapters/{chapterId}/lessons/{lessonId}

Response samples

200
404

Content type

application/json

{"id": "string",
"chapterEnrollmentId": "string",
"type": "string",
"attempts": 0,
"failures": 0,
"lastAttempt": "2019-08-24T14:15:22Z",
"courseEnrollmentId": "string",
"chapterId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}

List user's lesson enrollments from specific course.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> Enrollment identifier.
chapterEnrollmentId	string <guid> The Id of related ChapterEnrollment
type	string The type of ActivityEnrollment
attempts	integer <int32> Number of attempts
failures	integer <int32> Number of failures
lastAttempt	string <date-time> Date of the last attempt
courseEnrollmentId	string <guid> Id of the related CourseEnrollment
chapterId	string <guid> Id of the related Chapter
lessonId	string <guid> Id of the related Lesson
name	string Name of the Lesson Enrollment
userId	string <guid> Id of the related User
fullName	string Full name of the related User
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 Status of the Enrollment Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> Progress of this enrollment
score	number <decimal> Score of this enrollment
timeSpent	string <duration> The length of time the learner has spent in the course.
dateEnrolled	string <date-time> Date the User was enrolled
dateStarted	string <date-time> Date the User started.
dateCompleted	string <date-time> Date the user completed.
dateEdited	string <date-time> The last date edited.
dateAdded	string <date-time> The date the enrollment was added.

Response samples

200
404

Content type

application/json

[{"id": "string",
"chapterEnrollmentId": "string",
"type": "string",
"attempts": 0,
"failures": 0,
"lastAttempt": "2019-08-24T14:15:22Z",
"courseEnrollmentId": "string",
"chapterId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

Get user's lesson enrollment.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
lessonId required	string <guid> The lesson ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
chapterEnrollmentId	string <guid> The Id of related ChapterEnrollment
type	string The type of ActivityEnrollment
attempts	integer <int32> Number of attempts
failures	integer <int32> Number of failures
lastAttempt	string <date-time> Date of the last attempt
courseEnrollmentId	string <guid> Id of the related CourseEnrollment
chapterId	string <guid> Id of the related Chapter
lessonId	string <guid> Id of the related Lesson
name	string Name of the Lesson Enrollment
userId	string <guid> Id of the related User
fullName	string Full name of the related User
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 Status of the Enrollment Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> Progress of this enrollment
score	number <decimal> Score of this enrollment
timeSpent	string <duration> The length of time the learner has spent in the course.
dateEnrolled	string <date-time> Date the User was enrolled
dateStarted	string <date-time> Date the User started.
dateCompleted	string <date-time> Date the user completed.
dateEdited	string <date-time> The last date edited.
dateAdded	string <date-time> The date the enrollment was added.

Response samples

200
404

Content type

application/json

{"id": "string",
"chapterEnrollmentId": "string",
"type": "string",
"attempts": 0,
"failures": 0,
"lastAttempt": "2019-08-24T14:15:22Z",
"courseEnrollmentId": "string",
"chapterId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}

List user's lesson enrollments from specific chapter.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.
chapterId required	string <guid> The chapter ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The last modified date and time.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> Enrollment identifier.
chapterEnrollmentId	string <guid> The Id of related ChapterEnrollment
type	string The type of ActivityEnrollment
attempts	integer <int32> Number of attempts
failures	integer <int32> Number of failures
lastAttempt	string <date-time> Date of the last attempt
courseEnrollmentId	string <guid> Id of the related CourseEnrollment
chapterId	string <guid> Id of the related Chapter
lessonId	string <guid> Id of the related Lesson
name	string Name of the Lesson Enrollment
userId	string <guid> Id of the related User
fullName	string Full name of the related User
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 Status of the Enrollment Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
progress	number <decimal> Progress of this enrollment
score	number <decimal> Score of this enrollment
timeSpent	string <duration> The length of time the learner has spent in the course.
dateEnrolled	string <date-time> Date the User was enrolled
dateStarted	string <date-time> Date the User started.
dateCompleted	string <date-time> Date the user completed.
dateEdited	string <date-time> The last date edited.
dateAdded	string <date-time> The date the enrollment was added.

Response samples

200
404

Content type

application/json

[{"id": "string",
"chapterEnrollmentId": "string",
"type": "string",
"attempts": 0,
"failures": 0,
"lastAttempt": "2019-08-24T14:15:22Z",
"courseEnrollmentId": "string",
"chapterId": "string",
"lessonId": "string",
"name": "string",
"userId": "string",
"fullName": "string",
"status": 0,
"progress": 0,
"score": 0,
"timeSpent": "string",
"dateEnrolled": "2019-08-24T14:15:22Z",
"dateStarted": "2019-08-24T14:15:22Z",
"dateCompleted": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z"
}
]

Attempts

List user's attempts for specific lesson.

Authorizations:

api_key

path Parameters

userId required	string <guid> The course ID.
courseId required	string <guid> The course ID.
lessonId required	string <guid> The course ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The unique attempt identifier.
timeSpentTicks	integer <int64> The attempt's time spent in ticks.
status	integer Enum: 1 3 5 The attempt's status. Possible Enum Values: `1 = InProgress` `3 = Complete` `5 = Failed`
score	number <decimal> The attempt's score.
startDate	string <date-time> The attempt's start date.
completionDate	string <date-time> The attempt's completion date.

Response samples

200
404

Content type

application/json

[{"id": "string",
"timeSpentTicks": 0,
"status": 1,
"score": 0,
"startDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z"
}
]

Start attempt for active lesson enrollment.

Authorizations:

api_key

path Parameters

userId required	string <guid> The course ID.
courseId required	string <guid> The course ID.
lessonId required	string <guid> The course ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

attemptId	string <guid> The unique attempt identifier.
courseId	string <guid> The attempt's course ID.
userId	string <guid> The attempt's user ID.

Response samples

200
404
422

Content type

application/json

{"attemptId": "string",
"courseId": "string",
"userId": "string"
}

Finish attempt.

Authorizations:

api_key

path Parameters

attemptId

required

string <guid>

The attempt ID.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request body to finish an attempt.

status required	integer Enum: 1 3 5 The attempt's status. Possible Enum Values: `1 = InProgress` `3 = Complete` `5 = Failed`
score	number <decimal> The attempt's score.
startDate	string <date-time> The attempt's start date.
completionDate	string <date-time> The attempt's completion date.

Responses

Response Schema: application/json

attemptId

string <guid>

The unique attempt identifier.

Request samples

Payload

Content type

application/json

{"status": 1,
"score": 0,
"startDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z"
}

Response samples

200
404
422

Content type

application/json

{"attemptId": "string"
}

Finish attempt.

Finish a specific user's lesson attempt.

Authorizations:

api_key

path Parameters

userId required	string <guid> The course ID.
courseId required	string <guid> The course ID.
lessonId required	string <guid> The course ID.
attemptId required	string <guid> The attempt ID.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request body to finish a specific user's lesson attempt.

status required	integer Enum: 1 3 5 The attempt's status. Possible Enum Values: `1 = InProgress` `3 = Complete` `5 = Failed`
score	number <decimal> The attempt's score.
startDate	string <date-time> The attempt's start date.
completionDate	string <date-time> The attempt's completion date.

Responses

Response Schema: application/json

attemptId

string <guid>

The unique attempt identifier.

US

https://rest.myabsorb.com/users/{userId}/enrollments/{courseId}/lessons/{lessonId}/attempts/{attemptId}/finish

CA

https://rest.myabsorb.ca/users/{userId}/enrollments/{courseId}/lessons/{lessonId}/attempts/{attemptId}/finish

EU

https://rest.myabsorb.eu/users/{userId}/enrollments/{courseId}/lessons/{lessonId}/attempts/{attemptId}/finish

AU

https://rest.myabsorb.com.au/users/{userId}/enrollments/{courseId}/lessons/{lessonId}/attempts/{attemptId}/finish

Request samples

Payload

Content type

application/json

{"status": 1,
"score": 0,
"startDate": "2019-08-24T14:15:22Z",
"completionDate": "2019-08-24T14:15:22Z"
}

Response samples

200
404

Content type

application/json

{"attemptId": "string"
}

My Enrollments

Get currently authenticated user's course enrollment.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The specified date for filtering enrollments that were edited after this date.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Enrollment identifier.
courseId	string <guid> Course identifier.
courseName	string Name of the course.
progress	number <decimal> Percentage of course completed.
score	number <decimal> Score in percentage.
status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The enrollment status. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
dateCompleted	string <date-time> The date the enrollment was completed.
dateExpires	string <date-time> The date the enrollment expires.
dateEdited	string <date-time> The date enrollment was last edited.
dateAdded	string <date-time> The date the enrollment was added.
fullName	string Learner's full name.
courseVersionId	string <guid> Enrollment is for a specific course version.
userId	string <guid> Learner identifier.
acceptedTermsAndConditions	boolean Learner has accepted the terms and conditions.
timeSpentTicks	integer <int64> The length of time the learner has spent in the course (stored as ticks).
timeSpent	string <duration> The length of time the learner has spent in the course.
dateStarted	string <date-time> The date the learner started the course.
enrollmentKeyId	string <guid> When present, indicates the enrollment key used to enroll into the course.
certificateId	string <guid> When present, indicates the id of the certificate awarded for completing the course.
credits	number <decimal> When present, indicates the credits accumulated for the course.
isActive	boolean Indicates if the enrollment is the current (active) enrollment or a historical enrollment.
dateDue	string <date-time> The date enrollment is due.
accessDate	string <date-time> Course cannot be started until this date. Does not stop users from enrolling in it, though.
jobTitle	string Learner's job title.
courseCollectionId	string <guid> This is set if the Course is an Online Course or a Instructor Led Course that was enrolled in via a Course Bundle or Curriculum. This refers back to the CourseBundle's Id or Curriculum's Id.
avatar	string The display path of a User's Avatar.

Response samples

200
404

Content type

application/json

{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}

Create course enrollment for the currently authenticated user.

Multi-Session ILCs are not supported.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

enrollmentId	string <guid> The enrollment ID.
courseId	string <guid> the course ID.
userId	string <guid> The user ID.

Response samples

201
400
404
422

Content type

application/json

{"enrollmentId": "string",
"courseId": "string",
"userId": "string"
}

List currently authenticated user's course enrollments.

Authorizations:

api_key

query Parameters

status	integer Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 The specified status to filter by. Possible Enum Values: `0 = NotStarted` `1 = InProgress` `2 = PendingApproval` `3 = Complete` `4 = NotComplete` `5 = Failed` `6 = Declined` `7 = PendingEvaluationRequired` `8 = OnWaitlist` `9 = Absent` `10 = NotApplicable` `11 = PendingProctor` `12 = ReadyForReview`
modifiedSince	string <date-time> The specified date for filtering enrollments that were edited after this date.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (UserCourseEnrollmentResource)

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"enrollments": [{"id": "string",
"courseId": "string",
"courseName": "string",
"progress": 0,
"score": 0,
"status": 0,
"dateCompleted": "2019-08-24T14:15:22Z",
"dateExpires": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z",
"dateAdded": "2019-08-24T14:15:22Z",
"fullName": "string",
"courseVersionId": "string",
"userId": "string",
"acceptedTermsAndConditions": true,
"timeSpentTicks": 0,
"timeSpent": "string",
"dateStarted": "2019-08-24T14:15:22Z",
"enrollmentKeyId": "string",
"certificateId": "string",
"credits": 0,
"isActive": true,
"dateDue": "2019-08-24T14:15:22Z",
"accessDate": "2019-08-24T14:15:22Z",
"jobTitle": "string",
"courseCollectionId": "string",
"avatar": "string"
}
]
}