Register Learners for your Content

This is part of the tutorial series: Upload Content, Register Learners, and Track Progress:

1. Intro
2. Upload your Content
3. Register Learners
4. Track Progress
   
5. Recap
   
   

Create Registrations

Having content uploaded to SCORM Cloud wont do much good unless your users have a way to consume it. That’s where registrations come in. As mentioned before, registrations represent the link between a consumer of your content, and the content itself. It is also important to note that this is the sole billable unit in SCORM Cloud. Don’t worry about that if you’re on the free trial, you get 10 free registrations.

There are two steps we’ll take here to get this content playing. First we’ll create a registration, then launch the registration. Let’s look first at the CreateRegistration method. You’ll likely notice that you can supply a ton of information with this method. Don’t get too overwhelmed, we just need a few things for our purposes; mostly information about the learner taking the course.

This method takes a JSON POST body, and the minimum required object looks like this:

{
  "courseId": "my_course_id",
  "registrationId": "my_reg_id",
  "learner": {
    "id": "my_learner_id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  }
}

Supply an object like that (or even that object itself, as long as you used my_course_id to import the course), and you should get a 204 - No Content back. This shows us the registration is created and ready to use.

Launch Registrations

Next we want to actually allow our learner to take the course. For this we’ll use the method BuildRegistrationLaunchLink. This method will return a relatively short lived link that we can use to launch our content and take the course. You’ll likely notice again that there are a lot of options in the POST body on this one. Just like last time, we wont need all of them. In fact, there are only two requirements: what registration to launch, and where to take the learner after the course is complete. The registrationId is supplied in the path of the request. Our POST body object will look something like this:

{
  "redirectOnExitUrl": "https://cloud.scorm.com/"
}

The result of calling that method will look like this:

{
  "launchLink": "https://cloud.scorm.com/api/cloud/registration/launch/1482e51d-3287-436b-9385-ccdee240e42d"
}

That link will launch directly to the course content. The most typical use case here is to set this as the URL for an iframe embedded in your web application. However, you can just paste the link in your browser for now to launch the course. Take a moment to learn about golf and take a test, then we’ll see how you did.

Next up: View Registration Results