【API】 カタログ管理者の取得

  • 更新

ここでは、Learn365 API を使用して、カタログ管理者を取得する方法について説明します。

Learn365 API では、以下の 2 つの方法でカタログ管理者の情報を取得できます。

すべてのカタログとその管理者を取得する

特定のカタログとその管理者を取得する

 

すべてのカタログとその管理者を取得する

手順:

1.API にアクセスし、認証を行います。

https://api.365.systems/  にアクセスし、適切な API キーで認証されていることを確認してください。

2.エンドポイントを選択します。

CourseCatalogs セクション で以下のエンドポイントを選択し、右上の[Try it out]をクリックします。

GET /odata/v2/CourseCatalogs Returns the list of Course Catalogs 

3.$expand」フィールドに、 Owners と入力します。

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

catalog admins via API-1.jpg

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

  • ステータスコード 200 が返され、コースカタログの一覧が表示された場合は成功です。
  • 各コースカタログには Owners 配列が含まれており、すべてのカタログ管理者の詳細情報(Id、LoginName、Title(氏名)など)が確認できます。
  • エラーが発生した場合は、レスポンス本文にエラーオブジェクトが含まれます。このオブジェクトには、エラー内容を示す codemessage が含まれており、問題の原因を確認できます。

catalog admins via API-2.jpg

 

特定のカタログとその管理者を取得する

特定のカタログと管理者を API 経由で取得するには、コースカタログ ID が必要です。

コースカタログ ID は API を使用して取得できます。詳細な手順についてはこちらのドキュメントをご参照ください。

手順:

1.API にアクセスし、認証を行います。

https://api.365.systems/  にアクセスし、適切な API キーで認証されていることを確認してください。

2.エンドポイントを選択します。

CourseCatalogs セクション で以下のエンドポイントを選択し、右上の[Try it out]をクリックします。

GET /odata/v2/CourseCatalogs({Id}) Returns the Course Catalog by Id 

3.「Id」フィールドに コースカタログ ID を入力します。

4.「$expand」フィールドに Owners と入力します。

5.[Execute]をクリックしてリクエストを実行します。

catalog admins via API-3.jpg

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

  • ステータスコード 200 が返され、コースカタログの詳細が表示された場合は成功です。
  • レスポンス内の  Owners 配列では、カタログ管理者の詳細情報(Id、LoginName、Title(氏名)など)が確認できます。
  • エラーが発生した場合は、レスポンス本文にエラーオブジェクトが含まれます。このオブジェクトには、エラー内容を示す codemessage が含まれており、問題の原因を確認できます。

catalog admins via API-4.jpg