APIでユーザーをコースに登録する

  • 更新

LMS365では、LMS365 管理センター、またはLMS365 APIを使用してコースにユーザーを登録することができます。

ここでは、LMS365 APIを使用して、コースにユーザーを登録する方法についてご説明します。

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

2.Courses セクションを展開し、POST /odata/v2/Courses({Id})/Enroll Enrolls user or group into a Course を選択し、開いた画面で右上の「Try it out」を選択します。

Enroll users in a course via API1.png

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

  • key:Id:このパラメータは必須です。ユーザーまたはグループを登録するコースのIDを入力してください。

  • "userLoginName": "string":このパラメータは必須です。"string” を登録するユーザーのログイン名に置き換えます。

  • ”courseSessionId”:"string":このパラメータは2023年8月のリリースで廃止されました。Edit Value フィールドから削除してください。

  • "courseSessionIds":["guid"]:1つまたは複数のセッションに登録するタイプのコースにユーザを登録し、ユーザーをセッションまたはセッショングループに登録する場合、このパラメータは必須です
    セッションまたはセッショングループのIDを取得する方法は「APIでセッションまたはセッション・グループのIDを取得する」をご参照ください。
    1つのセッションに登録するタイプのコースの場合、"guid" をユーザーを登録するセッションまたはセッショングループのIDに置き換えます。
    複数のセッションに登録するタイプのコースの場合、"guid” をユーザを登録する場合、複数のセッションまたはセッショングループのIDをカンマで区切って置き換えます。
    1つまたは複数のセッションに登録するタイプのコースで、"courseSessionIds" パラメータが指定されない場合、ユーザーはセッションまたはセッショングループに登録されることなくコースに登録されます。ユーザーは、セッション/セッショングループを選択して登録するための通知を受け取ります。

    すべてのセッションに登録タイプの場合、courseSessionIds パラメータは省略できるはずですが、省略した場合、リクエストは失敗します。この場合、このパラメータを使用して、このコースのセッションとセッショングループのIDを指定して、ユーザーを登録することができます。

  • "ignoreMaxAttendees": true:すべてのセッションに登録するタイプのコースで、コースに参加者定員が設定されている場合のオプションパラメータです。
    「true」の場合、参加者定員の設定値に関わらず、ユーザーをコースに登録することができます。「false」にすると、参加者定員の設定値に達した場合、リクエストは失敗します。
    1つ、および複数のセッションに登録するタイプのコースでは、各セッションおよびセッショングループに対して参加者定員が設定されるため、”ignoreSessionRequirements” パラメータでこの設定をします。

  • "ignoreEnrollmentFlow": true:コースに自動承認登録フローが設定されている場合のオプションパラメータです。「true」の場合、コース登録フローに関係なく、ユーザーをコースに登録します。
    「false」にすると、コースに管理者承認またはラインマネージャー承認の登録フローが設定されている場合、ユーザーの登録は承認待ちステータスになります。

  • "ignoreEnrollmentDeadline": true:すべてのセッションに登録するタイプのコースで、コースに登録期限が設定されていない場合のオプションパラメータです。「true」の場合、コースの登録期限に関係なく、ユーザーをコースに登録します。

    「false」にすると、コースの登録期限を過ぎた場合、リクエストは失敗します。
    1つ、および複数のセッションに登録するタイプのコースでは、各セッションおよびセッショングループに対して登録期限が設定されるため、”ignoreSessionRequirements” パラメータでこの設定をします。

  • "ignoreSessionRequirements": true:1つ、および複数のセッションに登録するタイプのコースのオプションパラメータです。「true」の場合、各セッションおよびセッショングループに対して、個別に設定された要件(参加者定員、登録期限) に関係なく、コースにユーザーを登録します。
    「false」にすると、リクエスト本文が該当するセッションおよびセッショングループの条件を満たさない場合、リクエストは失敗します。

ここでは、複数のセッションに登録タイプのコースの2つのセッションにユーザを登録するリクエストの例を示します。

Enroll users in a course via API2.png

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

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

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、リクエストの結果を見ることができます。
    ユーザーの登録と登録内容が表示されます。また、RegistrationDate 行にはユーザーの登録日時が表示されます。ユーザーまたはグループはコースに登録され、関連する通知を受け取ります。
    LMS365管理センター>トレーニング管理>コースのユーザーセクションで登録を確認することができます。

Enroll users in a course via API3.png