How to get the start and end dates of Course Session via API

In this article, you will find out how to search for Course Session details using API.

First of all, you should get your API Key in Global Settings. This article will help you in case you've forgotten something:

API Keys Management

Then you should go to LMS API 365, and authorize using the aforementioned API key.

After that, you'll have different options to get the desired result.

1. Find the Courses section, expand it, find the GET method with the line Return the list of Courses and click Try it outThen use Expand query option and type CourseSessions there. After that scroll down to Execute button and press it.

11.jpg

In the "Response body" you'll find the list of all Courses with all the Sessions being added there. 

You can download the response or just search for the required course in the Response body window (using Ctrl+F). Then you should look for the expansion of the "CourseSessions" parameter, where you should find the list of all sessions from the course. Here you'll see the start and end dates of the course session.

22.jpg

2. There is a bit faster way to extract those dates using API if you've already gotten a Course ID. You can use the following article to get it:

How to get Course ID via API

Then you should go to the Courses section of LMS365 API, find the GET method with the line "Returns the Course by Id" and click Try it out. Use Expand query option and type CourseSessions there. After that scroll down to Execute button and press it.

33.jpg

Using this method, you won't need to make an additional search through the list of all courses which were created on your tenant. You'll get the list of the specific course sessions in a matter of seconds.

3. If you already have Course ID and Course Session ID, which could be found using the aforementioned methods, you can find the start and end dates of the course session via another function.

Once again go to the Courses section of LMS365 API, find the GET method with the line "Returns the Course Session by Id" and click Try it out

Enter Course ID and Course Session ID and click Execute button. The advantage of this method is that you get only the information about the specific course session and nothing more.

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

Comments

Article is closed for comments.