APIでコースセッションを更新する

  • 更新

LMS365では、LMS365 管理センター、またはLMS365 API を使用して、コースセッションを更新することができます。

ここでは、LMS365 API を使用して、コースセッションを更新する方法についてご説明します。

更新リクエストの実行に必要なデータを取得する

APIエンドポイント経由でコースセッションに変更を加える前に、いくつかの情報を収集する必要があります:

1.セッションが含まれるコースのIDを取得します。

2.更新するセッションのIDを取得します。

3.更新するセッションの内容を取得します。

セッションの詳細を取得するには、Courses セクションを展開し、
GET /odata/v2/Courses({id})/CourseSessions({courseSessionId})  Return the Course Session by Id 
を選択し、開いた画面で右上の「Try it out」を選択します。

 Course Id とCourse Session Id フィールドに、手順1、2で取得した ID を入力します。

準備ができたら「Execute」を選択してリクエストを実行します。

Update course session via API1.png

4.Responses ブロックで結果を確認します。

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、名前、開始日、終了日、タイムゾーン、登録期限、インストラクターなど、コースセッションの詳細が表示されます。

ダウンロードを選択してリクエストの結果を.JSONフォーマットでコンピュータに保存します。
これにより、コースセッションを更新するリクエストを実行する際に、この情報を引用することができます。

Update course session via API2.png

コースセッションを更新する

コースセッション情報の更新に使用するPUTメソッドは、入力された詳細情報だけでなく、すべてのセッション情報を更新します。そのため、パラメータはすべて指定する必要があり、指定されていないパラメータはデータなしの状態で上書きされますので注意してください。

1. https://api.365.systems/ にアクセスし、APIキーで認証します。

2.Courses セクションを展開し、PUT /odata/v2/Courses({id})/CourseSessions({courseSessionId})  Update Course Session  を選択し、開いた画面で右上の「Try it out」を選択します。

Update course session via API3.png

3.パラメータを設定します。

  • Course Id:更新するセッションを含むコースのIDを入力します。

  • Course Session Id :更新するセッションのIDを入力します。

Edit Value フィールドをセッションの詳細情報に置き換えます。指定されていないパラメータはNULLの値(つまり、元の情報は削除されます)に置き換えられますので注意してください。

※更新リクエストの実行に必要なデータを取得するの手順4でダウンロードした.JSONファイルを引用することをお勧めします。

以下のパラメータは必須です。

  • StartDate string($date-time):コースセッション開始日時
  • EndDate string($date-time):コースセッション終了日時
  • TimeZone string:コースセッションの開始日と終了日に使用されるタイムゾーン
    タイムゾーンのフォーマットはこちらで確認できます。タイムゾーン

Update course session via API4.png

4.準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、リクエストの結果が表示されます。コースセッション詳細情報が更新されます。

更新された情報は、LMS365管理センターまたは関連コースのコースホームページにアクセスして確認します。

Update course session via API5.png