Update a course session via API

To make changes to a course session, you can use the Learn365 Admin Center functionality or run an update request via LMS365 (Learn365) API endpoints. 

This article describes how to update a course session using the LMS365 (Learn365) API.

Update a course session via the LMS365 (Learn365) API, follow the steps:

To use the LMS365 (Learn365) API, you should be authorized with the relevant API key. For details, see this article.

NOTE   

The PUT method used to update the course session details updates all the session information. This means that all the parameters of the request must be specified. Otherwise, the parameters that aren't specified will be overwritten with no data.

1. In https:/api.365.systems, navigate to the Courses section and expand it.

2. Select the PUT/odata/v2/Courses({id})/CourseSessions({courseSessionId}) endpoint that updates a session or a group of sessions and select Try it out.

updates_sessions_.png

3. The opened Parameters section includes various query parameters that can be specified to run the request.

Complete the required fields:

  • In Course Id, enter the course ID
  • In courseSession Id, enter a session ID.
  • Edit the values of the parameters in the courseSession by replacing the relevant session details you want to update. See this article on how to get the details of the session you're updating.
  • Parameters that aren't edited will be replaced with blank values meaning the original parameters will be deleted.

Required parameters: 

StartDate string($date-time)
A session start date and time 
EndDate string($date-time)
A session end date and time
TimeZone string

Time zone used in course session's StartDate and EndDate

Find the list and format of time zones here.

 

complete_required_parameters_.png

4. Select Execute to run the request.

5. In the Responses block, check the results:

  • Number 2xx (for example, 200) under Code shows that the request worked correctly.
  • In the Response body field, the results of the request are displayed. The course session details are updated.

You can also use the Learn365 Admin Center functionality to check the updated course session.

the_response_body_.png

 

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

Comments

Article is closed for comments.