Get the ID of a session or session group via API

This article describes how to get the ID of a session or session group via API.

If you want to find sessions from a particular course, you’ll need the course ID. You can find it via the API by following the steps in this article.

To get a session or session group ID via the API:

1. Go to https://api.365.systems/ and make sure you're authorized with the relevant API key.

2. In the CourseSession section, select the GET /odata/v2/CourseSessions endpoint and select Try it out in the top right-hand corner.

3. You can use query option parameters to control the data in the response.

If you want to find sessions from a particular course, in the $filter field, enter CourseId eq {{courseId}}, where {{courseId}} is the ID of the course.

 

CourseSession request.png

 

4. Select Execute to run the request.

5. Go to the Response block to check the results:

  • 200 code with a list of courses indicates a successful response. Sessions have the IsGroup parameter set to false, session groups have it set to true.

    You can find the session or session group ID in the Id parameter.


    CourseSession response.png

  • 200 code with an empty body means there are no sessions to display.
  • In case of an error, the response body contains the error object with the code and message keys explaining the issue.

 

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

Comments

Article is closed for comments.