検索

【API】 ユーザーのラーニング モジュールを完了にする

  • 更新

Learn365 では、Learn365 管理センターまたは Learn365 API を通じて、ラーニング モジュールの進捗を変更（未開始、進行中 から「完了」）することができます。

ここでは、API を通じてラーニング モジュールの進捗を完了にする方法について説明します。

 

事前準備

ラーニング モジュールの進捗を完了にするには、該当するユーザーの登録 ID、そのラーニング モジュールの ID、および学習アイテムの ID を取得する必要があります。

これらは、以下の方法で取得します。

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

2．Courses セクションに移動し、GET /odata/v2/Courses Returns the list of Courses エンドポイントを選択し、右上の［Try it out］をクリックします。

3．クエリ オプション パラメータを入力します。

  • $expand：フィールドに「Enrollments, LearningModules」と入力します。これにより、レスポンスにコース内のユーザーの登録と、ラーニング モジュールに関する情報を含めることができます。

目的のラーニング モジュールが含むまれるコースの ID またはコースの名前がわかる場合、$filter でレスポンスをさらに絞り込むことができます。

  • $filter：フィールドに「Title eq 'course title'」または「Title eq 'course ID'」と入力します。「course title」と「course ID」は該当する値に置き換えます。

4．［Execute］を選択してリクエストを実行します。

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

  • Code 2xx（200など）は、リクエストが正しく動作したことを示します。
  • Response body には、ラーニング モジュールと、登録されているユーザーの情報を含むテナントのすべてのコースがリストされます。
  • Download で結果を.JSONフォーマットで保存してこの情報を引用することができます。

6．ラーニング モジュールの ID を、”LearningModules" の "Id"  パラメーター値から取得します。

Complete learning modules API-1.png

 

7．ユーザーの登録 ID を、"Enrollments"の "Id"  パラメーター値から取得します。

Complete learning modules API-2.png

 

8．ラーニング モジュールの ID を取得したら、ラーニング モジュール内の学習アイテムの ID を取得します。

① LearningModules セクションに移動し、GET method /odata/v2/LearningModules{Id} Returns the Learning Module by Id エンドポイントを選択し、右上の［Try it out］をクリックします。

② パラメータを入力します。

  • Id＊：「key: Id」フィールドに、該当のラーニング モジュールの ID を入力します。
  • $expand：フィールドに、「Configuration」と入力します。これにより、レスポンスにラーニング モジュールの学習アイテムに関する情報を含めることができます。

③ ［Execute］を選択してリクエストを実行します。

Complete learning modules API-3.png

 

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

  • Code 2xx（200など）は、リクエストが正しく動作したことを示します。
  • Response body には、ラーニング モジュールと、その中のすべての学習アイテムの情報が表示されます。

9．学習アイテム の ID を、"Items"の "Id"  パラメーター値から取得します。

Complete learning modules API-4.png

 

ラーニング モジュールを完了にする

必要な情報が取得できたら、リクエストを実行して当該ユーザーの関連するラーニング モジュールの進捗を完了にすることができます。

1．LearningModuleAttempts セクションに移動し、POST /odata/v2/LearningModuleAttempts Creates Learning Module Attempt エンドポイントを選択し、右上の［Try it out］をクリックします。

Complete learning modules API-5.png

 

2．パラメータを入力します。

  • LearningModuleAttempt＊：「Edit Value」フィールドに、次のパラメータを入力します。
    • "Id": "guid"：任意のパラメータ。「guid」を試行（LearningModuleAttempt）の ID に置き換えます。
    • "LearningModuleId": "guid"＊：必須のパラメータ。「guid」をラーニング モジュール ID に置き換えます。
    • "EnrollmentId": "guid"＊：必須のパラメータ。「guid」をユーザの登録 ID に置き換えます。
    • "PercentOfCompleting": "integer"：任意のパラメータ。「integer」を整数で置き換えます。入力されていない場合、システムは必須パラメータに提供された情報に基づいてこの値を自動的に計算します。
    • "IsCompleted": "boolean"：任意のパラメータ。「true」の場合、ラーニング モジュールは完了として設定されます。入力されていない場合、システムは必須パラメータに提供されたデータに基づいてこの値を自動的に設定します。
    • "IsCompletedCorrectly": "boolean"：任意のパラメータ。「true」の場合、ラーニング モジュールは正常に完了したとして設定されます。入力されていない場合、システムは必須パラメータに提供されたデータに基づいてこの値を自動的に設定します。
    • "PassingTimeTicks": "integer"：任意のパラメータ。「integer」を整数値で置き換えます。
    • "Status": "integer"：任意のパラメータです。「integer」を該当する数値に置き換えます。入力されていない場合、システムは必須パラメータに提供されたデータに基づいてこの値を自動的に設定します。
      • 未開始：0
      • 進行中：1
      • 完了：3
    • "State": "string"＊：必須のパラメータ。ラーニング モジュールのアイテムに対するユーザの試行ステータスです。「string」を{「item ID」:item status}で置き換えます。「item ID」は学習アイテム の ID に、「item status」は以下のいずれかに置き換えます。
      • アイテムは開始されていない：0
      • アイテムは合格し完了している：1
      • アイテムは失敗している：2

ラーニング モジュールに複数の学習項目がある場合、値は次のようになります。：

"{\"item ID\":item status, \"item ID\":item status, \"item ID\":item status}"

アイテムのステータスは、それぞれに入力されます。

入力例：

 

{
"LearningModuleId": "d2ac2f0b-da68-4355-92ae-f1f3c0462430",
"EnrollmentId": "0c15072c-d075-459d-b9ce-9999b6e7d6ea",
"State": "{\"f492afbe-26af-489f-92e5-d3e3550f1824\":1, \"13eb2f60-ee89-4130-a38b-ce59eee9aeeb\":1, \"d5be02b1-e574-4c62-8d08-0fea4646cdaa\":2, \"5e3eec35-7e76-4fb0-a55b-63830b0e0351\":1, \"b98d7bb0-8a2f-459f-830f-03b5d254de2a\":1}"

}

 

Complete learning modules API-6.png

 

 

3．［Execute］を選択してリクエストを実行します。

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

  • Code 2xx（200など）は、リクエストが正しく動作したことを示します。
  • Response body には、変更したラーニング モジュールの情報が表示されます。

Complete learning modules API-7.png

 

更新された情報は、Learn365管理センターで関連するコースから確認できます。