The iLMS API is for use in developing integrations with other systems. The iLMS API is a REST API which uses JSON for responses and features a unique login ID and key.
Contents
- Getting Started
- Users
- User Object Fields
- Get All Users / Search Users
- Get a User
- Create a User
- Update User Profile
- Inactivate a user
- Activate a user
- Delete a user
- Purge a user
- Reset Password and/or Force user to change password after login
- Groups
- Get All Groups
- Get a Group
- Get All Members / Users Of a Group
- Add a Member / User in Group
- Remove a Member / User from Group
- Get All Courses Of a Group
- Add a Course in Group
- Remove a Course from Group
- Modify Default Due Date and Requirement Type For A Group's Course
- Refresh a Group
- Get All Members / Users Of a Group's Explicit Inclusion List
- Add a User in Group's Explicit Inclusion List
- Remove a User from a Group's Explicit Inclusion List
- Get All Members / Users Of a Group's Explicit Exclusion List
- Add a User in Group's Explicit Exclusion List
- Remove a User from a Group's Explicit Exclusion List
- User Hierarchy - Region, Division, and Department
- Region
- Get All Regions
- Create a Region
- Update Region Name
- Delete a Region
- Division
- Get All Divisions
- Create a Division
- Update Division Name
- Delete a Division
- Department
- Get All Departments
- Create a Department
- Update Department Name
- Delete a Department
- Transcripts
- Get Transcripts Of A User
- Get Transcripts Of A User For A Specific Course
- Get Transcripts Of A User For A Specific Curriculum
- Get Transcripts Of A User For A Specific Session
- Modify User's Transcript For A Course/Curriculum/Session
- Courses
- Get All Courses
- Get A Course
- Get Only Due Date Settings of a Course
- Modify Due Date Settings of a course
- Inactivate a course
- Activate a course
- Curricula
- Get All Curricula/Search by Name
- Get A Curriculum
- Modify Due Date Settings of a curriculum
- Instructor-Lead Training Sessions
- Get All Sessions of a ILT/Event
- Get A Session
- Enrollments
- Get All The Enrollments Of A Course
- Enroll User In A Course
- Un-enroll User From A Course
- Get All The Enrollments Of A Curriculum
- Enroll User In A Curriculum
- Un-enroll User From A Curriculum
- Get All The Enrollments Of A Session
- Enroll User In A Session
- Un-enroll User From A Session
- Reports
- Get Summary Report Of a Course, Curriculum or ILT Session
- Status Codes
- 2xx - Success
- 4xx - Error Client Slide
- 5xx - Error on Server Side
- Region, Time, and Language Codes
- Time Zone
- Country
- US - States
- Canada - States (Provinces)
- Languages
- Pagination
- Sorting