【API】 ユーザーのアクティブな登録 ID の取得

  • 更新

ここでは、Learn365 API を通じた、Learn365 におけるユーザーのアクティブな登録 ID の取得について説明します。

 

API を通じたユーザーのアクティブな登録 IDの取得は、以下の手順に沿って行います。

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

2.Enrollments セクションに移動し、GET /odata/v2/Enrollments  Returns the list of current user's active Enrollments を選択し、右上の[Try it out]をクリックします。

ID of user's active enrollments1.png

 

3.必要に応じて、パラメータを設定します。

クエリ オプション パラメータでレスポンス データを絞り込むことができます。テナントで有効なすべてのユーザーの登録データを取得したい場合は、フィールドは空のままにします。

ユーザーのアクティブな登録が持つすべてのセッションの ID とタイトルを含めるには、$expand フィールドに「AllCourseSessions」と入力します。

例:特定のコースのアクティブな登録の情報を取得する場合

$filter フィールドに「CourseId eq ID」 と入力します。ID は該当するコースの ID に置き換えます。コース ID の取得については、こちらをご参照ください。

これにより、レスポンスにはこのコースに関連するすべての受講者のアクティブな登録のみが返されます。

入力例:CourseId eq d7b7ee6a-fa95-490e-b08a-1c352159d219

 

さらに、ユーザーIDで、このコースの特定の受講者のアクティブな登録 ID をだけを返すことができます。

入力例:CourseId eq d7b7ee6a-fa95-490e-b08a-1c352159d219 and UserId eq 0cbb7c72-b939-4efa-b6f7-33244e65708f

ID of user's active enrollments2.png

 

4.[Execute]を選択してリクエストを実行します。

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

  • Code 2xx(202など)は、リクエストが正しく動作したことを示します。
  • クエリ オプション パラメータが設定されていない場合、Response body にはテナント上のすべてのユーザーのすべてのアクティブな登録に関するデータが表示されます。
  • ”Id” パラメータの値は、コースにおけるユーザーの一意の登録 ID です。
  • クエリ オプション パラメータが設定された場合、Response body には該当するデータのみが表示されます。
  • Ctrl+Fで特定の ID を検索することができます。
  • Download オプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。

ID of user's active enrollments3.png