LMS365 Cloud API allows to integrate with other applications to streamline organizational processes and improve business performance. All LMS365 API endpoints are grouped in sections according to their purpose and functionality and in this article we provide a list of these sections with the description.
- The sections are presented alphabetically. The description of the sections is based on the general functionality of the APIs included, with no query options parameters set.
- To be able to use LMS365 APIs you need to authorize first.
The Apps section contains obsolete APIs that allow to get the list of applications of the tenant and their IDs.
In the Assessments section you can find APIs that allow to get the data related to assessments of the tenant—IDs of the assessment and of the course it is a part of, assessment's title, description, supervisor and settings. Also, APIs from this section allow to create, update, delete and approve assessments.
Here in the Assignments section you can find API endpoints that can be used to create new assignments, get the list of assignments of the tenant and their IDs, and to make assignments complete.
Using the APIs from the CertificateTemplates section, you can get the list of all certificate templates of the tenant, as well as create, update or delete certificate templates.
In the Certificates section you can find APIs that allow to get the data related to certificates of the tenant—ID, image, users with these certificates, to create new certificates and reissue the existing, and to upload certificate images.
Use the API endpoints from the Competencies (skills) section to get the list of all skills of the tenant as well as to create, update or delete skills.
CompetencyCategories (skill categories)
The CompetencyCategories (skill categories) section provides APIs allowing to get the list of categories set for skills in the tenant as well as to create, update or delete skill categories.
CompetencyScaleSets (skill level sets)
The APIs from the CompetencyScaleSets (skill level sets) section help to get the list of skill level sets of the tenant as well as to create, update and delete skill level sets.
Here in the CompetencyTags (tags) section you can find API endpoints with the help of which you can get the list of skill tags of the tenant, and to create, update or delete skill tags.
The CourseCatalogs section is rich for API endpoints that allow to create new course catalogs in the tenant, update the existing ones or their parts, get the list of course catalogs of the tenant and their ID, as well as to add to and remove users from the course catalogs.
The CourseCategories section provides the APIs to create, update and delete categories, as well as to get the list of the categories of the tenant.
Here in the CourseCompletionSets section there are listed APIs that allow to create, update and delete course completion sets, and to get the list of completion sets for courses of the tenant.
The CourseImages section provides API endpoints to upload images for courses and course banners.
The API endpoints of the CourseLayouts section are deprecated.
APIs from the Courses section covers getting the list of courses (general and on specific requests) and their data (ID, images), creating, updating and deleting courses, enrolling to and unenrolling users from them, managing course rating and course completion settings, as well as adding, updating and deleting course sessions.
- Getting the ID of a course via API
- Getting the URL of a course via API
- Getting the ID of a course session via API
- Getting the start and end dates of a course session via API
- Using the Admins and Trainers entities in the GET /odata/v2/Courses request
- Checking the creation status of a course via API
The API endpoints from the CourseSessions section allow to get the list of course sessions of the tenant.
In the CourseSessionRequests section you can find a list of APIs that allow to get the list of all session requests of the tenant depending on the parameters set, and to add and delete course session requests.
The CourseTags section provides APIs to get the list of all course tags in the tenant as well as to create, update and delete course tags.
The APIs from the EnrollmentFlows section allow to get the data about the enrollment flows of the tenant.
The Enrollments section covers such APIs that you can use to deal with users' enrollments in the tenant: create, return, approve, cancel, reject and other actions.
Here in the ExternalApps section you can find the API endpoints get the list of external apps in the tenant, add, replace and delete external apps, and change the position of the external app in a course.
With the API endpoints from the ExternalTrainings section it's possible to import courses, training progress, and certificates to the tenant.
With API endpoints from the LearningModuleAttempts section you get the list of users' attempts in learning modules of the tenant, as well as update and delete users attempts or create new ones.
The APIs in the LearningModules section help to get a list of learning modules of all the courses of the tenant, update and delete them as well to create new ones.
Here in the QuestionPoolCategories section you can find APIs to help you get the list of question pool categories of the tenant and to create new categories for question pools.
In the QuizAttempts section there are API endpoints that allow to get the list of users' quiz attempts within the tenant.
Here in the QuizQuestionPools section you can find APIs to get the list of question pools of the tenant and to create new ones.
Use API endpoints from the Quizzes section to get the list of quizzes of the tenant, update or delete a quiz, or to create a new one.
The API endpoint of the Reports section allows to get the data about the course session cost per user in the tenant.
Here in the ScormAttempts section you can find API endpoints that allow to get the list of attempts of all users in all SCORMs of the tenant, and to create a new SCORM or update an existing one.
The Scorms section covers APIs that allow to upload zip files to the tenant and create content packages based on them, as well as to manage the existing SCORMs: get the list of SCORMs and their ID, SCORM's content and content URL, change the position of SCORMs among learning items in courses, and to delete content packages.
The TrainingPlans section contains APIs that allow to get the list of training plans of the tenant.
UserCompetencies (user skills)
Here in the UserCompetencies (user skills) section there are APIs that allow to get the list of all the skills of all users in the tenant.
The APIs from the UserRanks section allow to get the data on users ranking in the tenant by the number of CEUs they've earned.
The Users section covers APIs with the help of which you can get the list of users of the tenant, get, purge, merge or update users' data, as well as grant and revoke skills.
- Getting the ID of a user via API
- Getting the login name of a user or a group via API
- Revoking user's skills via API
The APIs from theWaitingListRequests section allow to get the data on user's waiting list requests, as well as create and delete waiting list requests.
The WebHookRegistrations section provides API endpoints on subscribing and unsubscribing WebHooks in the tenant, getting data about the users' WebHooks and registering new ones, as well as updating and deleting WebHook registrations.