Keywords:
API |
The Course Enrollment API performs actions related to course enrollments in the Inquisiq LMS. The following methods are available via this API:
- Enroll a user in course(s)
- Get course enrollment details
- Update course enrollment
- Delete course enrollment
- Reset course enrollment
Enroll a user in course(s)
HTTP Action |
POST |
|||||||||||||||||||||||||||
Base URL |
https://[Your Inquisiq LMS Portal URL] |
|||||||||||||||||||||||||||
Endpoint URL |
/api/courseenrollment/v2/enroll |
|||||||||||||||||||||||||||
Request Parameters |
Example: { "IdUser": 2, "CourseIds": [ 123 ], "IsLockedByPrerequisites": true, "Timezone": "Eastern Standard Time", "StartDate": "2021-07-01", "Due": { "Interval": 30, "Timeframe": "d" }, "AccessFromStart": null, "AccessFromFirstLaunch": null } |
|||||||||||||||||||||||||||
Response |
The id of the course enrollment that was created. Example: 123456 |
Get course enrollment details
HTTP Action |
GET |
Base URL |
https://[Your Inquisiq LMS Portal URL] |
Endpoint URL |
/api/courseenrollment/v2/{id} |
Request Parameters |
NONE |
Response |
A course enrollment object matching the {id} of the course enrollment. Example: { "Id": 123456, "IdSite": 2, "IdCourse": 123, "IdUser": 2, "IdGroupEnrollment": null, "IdRuleSetEnrollment": null, "IdLearningPathEnrollment": null, "IdTimezone": 15, "IsLockedByPrerequisites": true, "Code": null, "RevCode": "IHC6D96FLG5M85HA8BFJ65KC8DM79BAG", "Title": "My Course", "DtStart": "2021-07-01T04:00:00Z", "DtDue": "2021-01-31T04:00:00Z", "DtExpiresFromStart": null, "DtExpiresFromFirstLaunch": null, "DtEffectiveExpires": null, "DtFirstLaunch": null, "DtCompleted": null, "DtCreated": "2021-06-29T07:59:18.813Z", "DtLastSynchronized": "2021-06-29T07:59:18.813Z", "DueInterval": 30, "DueTimeframe": "d", "ExpiresFromStartInterval": null, "ExpiresFromStartTimeframe": null, "ExpiresFromFirstLaunchInterval": null, "ExpiresFromFirstLaunchTimeframe": null, "IdActivityImport": null, "NumberOfLessons": 1, "NumberOfLessonsCompleted": 0, "IsPartOfLearningPath": false, "IsPartOfCertification": false, "IsSelfEnrollment": false, "CourseEnrollmentLink": "/dashboard/v2/Enrollment.aspx?id=123456" } |
Update course enrollment
HTTP Action |
PUT |
||||||||||||||||||
Base URL |
https://[Your Inquisiq LMS Portal URL] |
||||||||||||||||||
Endpoint URL |
/api/courseenrollment/v2/{id} |
||||||||||||||||||
Request Parameters |
Example: { "IsLockedByPrerequisites": true, "StartDate": "2021-07-15", "Due": { "Interval": 30, "Timeframe": "d" }, "AccessFromStart": null, "AccessFromFirstLaunch": null } |
||||||||||||||||||
Response |
The id of the course enrollment. Example: 123456 |
Delete course enrollment
HTTP Action |
DELETE |
Base URL |
https://[Your Inquisiq LMS Portal URL] |
Endpoint URL |
/api/courseenrollment/v2/{id} |
Request Parameters |
NONE |
Response |
NONE (200 - OK) |
Reset course enrollment
HTTP Action |
GET |
Base URL |
https://[Your Inquisiq LMS Portal URL] |
Endpoint URL |
/api/courseenrollment/v2/{id}/reset |
Request Parameters |
NONE |
Response |
NONE (200 - OK) |
Comments
0 comments
Please sign in to leave a comment.