Use Cases

This guide provides essential information for initiating the integration process with our APIs. It serves as a roadmap, guiding you through the primary use cases below.

The order of the steps within each use case is important! Completing the first step will result in required information to be used in the second step, and so on. Additionally, each guide will describe companion API endpoints. These endpoints retrieve specific data used to complete the step.

Note: Learners created during the enrollment steps will receive a SkillsPass system notification regarding their account as well the learner will receive a Certificate Awarded notification when a successful class record is recorded.

Before continuing, visit the Authentication page to review the requirements to authenticate calls, and get the base URLs for the sandbox and production environments.

Training Provider

Use-Case 1: Instructor-led Classes

Publish Classes to an online marketplace

• Creating a class

Submit learning records on behalf of learners

• Creating a class
• Enrolling learners in the class
• Submitting learning records for the learners

Use-Case 2: E-Learning

• Enrolling learners in an e-learning course
• Submitting e-learning records for the learners

Organization

Export Data

• Create an export data job
• Getting the status of an export data job