Register users for specific standalone sessions and session groups via API

Introduction

There may be a scenario where a user is enrolled in an instructor-led course of the single- or multiple- enrollment type but they haven't registered for any of its standalone sessions or session groups. You can use the LMS365 (Learn365) API to register a user for standalone sessions or session groups.

This article describes the process of registering a user for standalone sessions or session groups by associating their course enrollment with standalone sessions or session groups.

 

Prerequisites 

  • The user who you want to register for specific standalone sessions or session groups should already be enrolled in an instructor-led course of the single- or multiple- enrollment type via the Learn365 Admin Center, self-enrolled from the course home page, or enrolled via the LMS365 (Learn365) API. This will mark the registration status of the user's enrollment as Active or Awaiting in LMS365 (Learn365), meaning they can be registered for specific standalone sessions or session groups.

  • To register a user for specific standalone sessions or session groups via the LMS365 (Learn365) API, you'll need their enrollment ID.

 

Register users for standalone sessions or session groups

Once a user is enrolled in a course, you can associate their enrollment with specific standalone sessions or session groups of this course. Depending on the enrollment type, it can be a single standalone session or session group, or multiple sessions or groups.

To register a user for standalone sessions or session groups via API, follow these steps:

1. Find and expand the Enrollments section, find and expand the POST /odata/v2/Enrollments({Id})/AssociateWithCourseSession method with the Associates enrollment with course session(s) description, and select Try it out in the top right-hand corner.

 

2023-07-31 18_36_36-Swagger UI.png

 

2. Complete the required parameter:

 

To register a user for a single standalone session or session group for courses of the single- enrollment type, use the ID of the selected standalone session or session group.

{
  "courseSessionIds": [
  "d9080ef9-848a-453b-af7e-2aeb7944ac99"
  ]
  }

 

To register a user for multiple standalone sessions or session groups for courses of the multiple- enrollment type, you'll need to add the ID of each standalone session and/or session group, separated by commas.

{
  "courseSessionIds": [
  "d9080ef9-848a-453b-af7e-2aeb7944ac99", "f749c75b-335a-4869-a729-b859fbd04d6a"
  ]
  }

 

This following image shows an example request, where a user is being registered for one standalone session and one session group of a course of the multiple- enrollment type.


 

3. When ready, select Execute to run the request.

 

4. Go to the Responses block to check the results:

  • Number 2xx (for example, 204) under Code shows that the request worked correctly.



  • At this stage, the user will be registered for the selected standalone sessions or session groups of the course. To check this, go to the Learn365 Admin Center > select the relevant course > Manage People > check if the required user is registered for the relevant standalone sessions or session groups. 

  • You can download this data to your local device ​in JSON format using the Download option.

 

Was this article helpful?
2 out of 2 found this helpful

Comments

Article is closed for comments.