検索

API によるコースへのユーザー登録

  • 更新

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

ここでは、Learn365 API を通じた、コースへのユーザー登録について説明します。

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

 

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

  • id＊：「key:Id」フィールドに、ユーザーまたはグループを登録するコースの IDを入力します。

  • parameters＊：「Edit Value」フィールドで、以下を入力します。
    • "userLoginName": "string"：「string」を登録するユーザー/ グループのログイン名、カスタム ユーザー グループの場合は ID に置き換えます。

    • ”courseSessionId”:"string"：このパラメータは2023年8月のリリースで廃止されました。Edit Value フィールドから削除してください。
       
    • "courseSessionIds"：登録タイプ「1つ、または複数のグループまたはセッション」の集合トレーニング コースにユーザーを登録し、ユーザーをセッションまたはセッショングループにも登録するには、このパラメータは必須です。
      ["guid"]に登録するセッション/セッション グループのIDを入力します。
      セッション/ セッション グループのIDの取得については、こちらを参照してください。

      • 1つのグループまたはセッションの場合、「guid」をユーザーを登録するセッションまたはセッション グループのIDに置き換えます。

      • 複数のグループまたはセッションの場合、「guid」をユーザーを登録するセッションまたはセッション グループのIDをカンマで区切って入力し置き換えます。

      • すべてのセッションとグループの場合、courseSessionIds パラメータは省略します。そうしないと、要求は失敗します。
        ただし、このパラメータを使用してこのコースの特定のセッション/セッション グループのIDを指定することにより、登録タイプ「すべてのセッションとグループ」のコースの特定のセッション/ セッション グループにユーザーを登録することができます。

      • "courseSessionIds" パラメータが指定されない場合、ユーザーはセッションまたはセッション グループには登録されず、コースにのみ登録されます。この場合、ユーザーは「セッション 登録要求」通知を受け取ります。


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

  • "ignoreEnrollmentFlow": true：このパラメータは、コースの登録フローが「自動承認」以外のに設定されている場合のオプションです。
    「true」の場合、コースの登録フローにかかわらず、ユーザーをコースに登録します。
    「false」にすると、管理者の承認、ライン マネージャのー承認、または外部認証（Webhook）が設定されている場合、ユーザーの登録は承認待ちになります。 

  • "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（202など）は、リクエストが正しく動作したことを示します。
  • Response body では、リクエストの結果を確認します。
    ユーザーの登録と登録内容が表示されます。また、RegistrationDate 行にはユーザーの登録日時が表示されます。
    コースに登録されたユーザー/グループは、関連する通知を受け取ります。
    Learn365管理センターでは、関連するコースの「ユーザー」セクションで登録を確認することができます。

Enroll users in a course via API3.png