APIでユーザーを特定のコースセッションに登録する

  • 更新

LMS365 では、1つまたは複数のセッションに登録するタイプのインストラクター主導型コースに登録されたユーザーが、そのコースの何れのセッション、またはセッショングループに登録されていない場合、LMS365 API を使用して、ユーザーをセッションまたはセッショングループに登録することができます。

ここでは、その方法についてご説明します。

前提条件

  • セッションまたはセッショングループに登録するユーザーは、ユーザーによるコースホームページからの登録、または管理者によってLMS365 管理センター、あるいはLMS365 API 経由で、1つまたは複数のセッションに登録するタイプのコースに登録済みである必要があります。
    この場合、LMS365において、ユーザーの登録ステータスは「アクティブ」または「待機中」となり、ユーザーが特定のセッションまたはセッショングループに登録可能であることを示しています。

  • LMS365 APIで、ユーザーを特定のセッションまたはセッショングループに登録するには、ユーザーのアクティブな登録IDが必要です。

セッションまたはセッショングループにユーザーを登録する

コースのセッションの登録タイプに応じて、1つのセッション/セッショングループ、または複数のセッション/グループに登録することができます。

セッションまたはセッショングループにユーザーを登録するには、以下の手順で行います

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

2.Enrollments セクションを展開し、 POST /odata/v2/Enrollments({Id})/AssociateWithCourseSession Associates enrollment with course session(s) を選択し、開いた画面で右上の「Try it out」を選択します。

sessions and session groups via API1.png

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

  • key:Id:このパラメータは必須です。登録するユーザーの登録IDを入力します。

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

  • "courseSessionIds":["guid"]:"guid" をユーザーを登録するセッション/セッショングループのIDに置き換えます。

1つセッション/グループに登録するタイプのコースの場合、特定のセッションまたはセッショングループのIDを入力します。

{ "courseSessionIds": [

"d9080ef9-848a-453b-af7e-2aeb7944ac99"

]

複数のセッション/グループに登録するタイプのコースの場合、登録するセッション/セッショングループのIDを、カンマ区切りで入力します。

{
"courseSessionIds": [
"d9080ef9-848a-453b-af7e-2aeb7944ac99", "f749c75b-335a-4869-a729-b859fbd04d6a"
]
}

下の図は、複数のセッションに登録タイプのコースに登録されているユーザーを、このコースの1つセッションと、1つのセッショングループに登録するリクエストの例です。
sessions and session groups via API2.png

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

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

  • Codeの下にある2XX(例:204)という数字は、リクエストが正しく動作したことを示します。
  • Response headersで、リクエストの結果を見ることができます。
    この段階で、ユーザーは指定したコースのセッション/セッショングループに登録されます。
    これらの登録は、LMS365 管理センター>コース設定パネルのユーザーセクションで確認できます。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

sessions and session groups via API3.png