LMS365 Cloud API enables integration with other applications, to streamline organizational processes and improve business performance. LMS365 API endpoints are grouped into sections according to their purpose and functionality.
In this article, we provide information on the content of each of these sections.
TIP
- The sections are presented alphabetically. The description of each section is based on the general functionality of the APIs included in the section, with no query option parameters set.
- To be able to use LMS365 APIs, you need to log in first.
Apps
The Apps section contains APIs that are no longer used as separate applications but are a built-in part of the LMS365 solution. These APIs enable you to get a list of all the applications on the tenant, together with their IDs.
Assessments
The Assessments section contains the APIs that enable you to get information relating to assessments on the tenant. This information includes the IDs of the assessment and the course that it's part of, the assessment title, description, supervisor, and settings. The APIs in this section enable you to create, update, delete, and approve assessments.
Assignments
The Assignments section contains the API endpoints that are used to create new assignments, get a list of assignments on the tenant and their IDs, and mark assignments as complete.
CertificateTemplates
The CertificateTemplates section contains the APIs that are used to get a list of all certificate templates on the tenant, as well as create, update, and delete certificate templates.
Certificates
The Certificates section contains the APIs that are used to get information relating to certificates on the tenant, including the ID, image, and the users who have been awarded these certificates, as well as create certificates, reissue existing certificates, and upload certificate images.
Related articles:
Competencies (skills)
The Competencies (skills) section contains the API endpoints that enable you to get a list of all skills on the tenant, as well as create, update, and delete skills.
CompetencyCategories (skill categories)
The CompetencyCategories (skill categories) section contains the APIs that enable you to get a list of skills categories on the tenant, as well as create, update, and delete skill categories.
CompetencyScaleSets (skill level sets)
The CompetencyScaleSets (skill level sets) section contains the APIs that enable you to get a list of skill level sets on the tenant, as well as create, update, and delete skill level sets.
CompetencyTags (tags)
The CompetencyTags (tags) section contains the API endpoints that enable you to get a list of skill tags on the tenant, and to create, update, and delete skill tags.
CourseCatalogs
The CourseCatalogs section contains the API endpoints that enable you to create new course catalogs on the tenant, update existing ones or parts of them, get a list of course catalogs on the tenant and their ID, add users to course catalogs, and remove users from them.
Related articles:
- Get the ID of a course catalog via API
- Delete users and Azure AD groups from a course catalog via API
- Change the title and URL of a course catalog
CourseCategories
The CourseCategories section contains the APIs that enable you to create, update, and delete categories, as well as get a list of the categories on the tenant.
Related articles:
CourseCompletionSets
The CourseCompletionSets section contains the APIs that enable you to create, update, and delete course completion sets, and to get a list of completion sets for courses on the tenant.
CourseImages
The CourseImages section contains the API endpoints that enable you to upload images for courses and course banners.
CourseLayouts
The API endpoints in the CourseLayouts section are deprecated.
Courses
The Courses section contains the APIs that enable you to get a list of courses (both general and requests with specified parameters set) and various details, as well as create, update, and delete courses. There are also APIs that enable you to enroll in courses, unenroll from them, manage course ratings, and manage course completion settings. You can also add, update, and delete course sessions.
Related articles:
- Get the ID of a course via API
- Get the URL of a course via API
- Get the ID of a course session via API
- Get the start and end dates of a course session via API
- Admins and Trainers entities in the GET /odata/v2/Courses endpoint
- Check the creation status of a training via API
- Purge data of a course or training plan from LMS365 via API
- Create courses via API
- Enroll users in a course via API
- Enroll users in training plans via API
- Unenroll a user/group from courses or training plans via API
- Update course session via API
CourseSessions
The CourseSessions section contains the API endpoints that enable you to get a list of all course sessions on the tenant.
Related articles:
CourseSessionRequests
The CourseSessionRequests section contains the APIs that enable you to get a list of all session requests on the tenant depending on the parameters set, and to add and delete course session requests.
CourseTags
The CourseTags section contains the APIs that enable you to get a list of all course tags on the tenant, as well as create, update, and delete course tags.
EnrollmentFlows
The EnrollmentFlows section contains the APIs that enable you to get information relating to the enrollment flows on the tenant.
Enrollments
The Enrollments section contains the APIs that enable you to create, return, approve, cancel, and reject enrollments, as well as other actions.
Related articles:
ExternalApps
The ExternalApps section contains the API endpoints that enable you to get a list of external apps on the tenant, and to add, replace, and delete external apps. You can also change the position of external apps in a course.
ExternalTrainings
The ExternalTrainings section contains the API endpoints that enable you to import courses, training progress, and certificates into the tenant.
LearningModuleAttempts
The LearningModuleAttempts section contains the API endpoints that enable you to get a list of users' attempts in learning modules on the tenant, as well as update and delete users attempts, and create new ones.
LearningModules
The LearningModules section contains the APIs that enable you to get a list of learning modules of all the courses on the tenant, as well as create, update, and delete them.
Related articles:
QuestionPoolCategories
The QuestionPoolCategories section contains the APIs that enable you to get a list of question pool categories on the tenant and to create new categories for question pools.
QuizAttempts
The QuizAttempts section contains the API endpoints that enable you to get a list of users' quiz attempts on the tenant.
QuizQuestionPools
The QuizQuestionPools section contains the APIs that enable you to get a list of question pools on the tenant and to create new ones.
Quizzes
The Quizzes section contains the API endpoints that enable you to get a list of quizzes on the tenant, update and delete a quiz, and to create a new one.
Reports
The Reports section contains the API endpoint that enable you to get information relating to the cost per user for course sessions on the tenant.
Related articles:
ScormAttempts
The ScormAttempts section contains the API endpoints that enable you to get a list of attempts of all users in all SCORMs on the tenant, and to create and update SCORMs.
Scorms
The Scorms section contains the APIs that enable you to upload zip files to the tenant and create content packages based on them. They also enable you to manage existing SCORMs, including getting a list of SCORMs and their IDs, the content of SCORMs, the content URL, as well as change the position of SCORMs among other learning items in courses and delete content packages.
Related articles:
- Upload files and create content packages via LMS365 API
- How to set Sharing when updating a SCORM using PUT/odata/v2/Scorms({Id})
TrainingPlans
The TrainingPlans section contains the API endpoints that enable you to get a list of training plans (both general and requests with specified parameters set), and add, exclude, or update a course in the training plan.
Related articles:
UserCompetencies (user skills)
The UserCompetencies (user skills) section contains the APIs that enable you to get a list of all the skills of all users on the tenant.
Related articles:
UserFields
Use UserFields section contains the API endpoints that enable you to get information relating to the columns in the Users section on the tenant, to update and delete them, and to create user columns.
Related articles
UserRanks
The UserRanks section contains the APIs that enable you to get information relating to user rankings on the tenant by the number of CEUs they've earned.
Users
The Users section contains the APIs that enable you to get a list of users on the tenant, to get, purge, merge and update users' information, and to grant and revoke skills.
Related articles:
- Get the ID of a user via API
- Get the login name of a user or a group via API
- Revoke user's skills via API
- Merge user accounts in LMS365 via API
- Purge a user and user's data from LMS365 via API
WaitingListRequests
The WaitingListRequests section contains the APIs that enable you to get information relating to user waiting list requests, as well as create and delete waiting list requests.
WebHookRegistrations
The WebHookRegistrations section contains the API endpoints that enable you to subscribe to and unsubscribe from WebHooks on the tenant, get information about the users' WebHooks, register new ones, and update and delete WebHook registrations.
Comments
Article is closed for comments.