APIでセッションの開始日と終了日を取得する

  • 更新

ここでは、LMS365 API を使用して、コースセッションの開始日と終了日を取得する方法をご説明します。

コースIDを用いてデータを取得する

特定のコースセッションの開始日と終了日を取得する際、関連するコースのIDを持っている場合は、以下の手順で行います。

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

2.Courses セクションを展開し、GET /odata/v2/Courses  Returns the Course by Id を選択し、開いた画面で右上の「Try it out」を選択します。

3.フィールドに入力します。

  • Id:セッションの開始日と終了日を取得するコースの ID
  • $expand :”CourseSessions”

コースID と $expand クエリオプションを使用すれば、追加の検索をする必要がなくなります。

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

Get the start and end dates1.png

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

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、セッションの開始日と終了日のデータを含む、特定のID、セッショングループ、セッションのコースが表示されます。
  • 単独のセッションとセッショングループ内のセッションには、対応するパラメータの横に開始日と終了日が表示されます。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

Get the start and end dates2.png

セッショングループ(GroupId の値が ”true”)の場合、StartDate と EndDate パラメータは、それぞれ「1753-01-01T00:00:00Z」と「9999-12-31T23:59:59.997Z」が表示されます。

Get the start and end dates3.png

セッションIDを用いてデータを取得する

この方法の利点は、特定のセッションに関する必要な情報のみを取得できることです。

特定のコースセッションの開始日と終了日を取得する際、このセッションのIDを持っている場合は、以下の手順で行います。

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

2.CourseSessions セクションを展開し、GET /odata/v2/CourseSessions({Id})  Returns Course Session or Group of Sessions by id  を選択し、開いた画面で右上の「Try it out」を選択します。

3.key: Id フィールドに、開始日と終了日を取得するセッションの ID を入力し、「Execute」を選択してリクエストを実行します。

Get the start and end dates4.png

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

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、開始日と終了日を含む、この特定のセッションに関連するデータが表示されます。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

Get the start and end dates5.png

コース、セッションの ID を用いない場合

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

2.Courses セクションを展開し、GET /odata/v2/Courses  Returns the Course by Id を選択し、開いた画面で右上の「Try it out」を選択します。

3.$expand フィールドに「CourseSessions」を設定し、「Execute」を選択してリクエストを実行します。

様々なクエリオプションパラメータを使用し、フィルタを設定することにより、レスポンスのデータを制御することができます。パラメータを使用して、レスポンスに検索に使用可能な追加データと詳細を含めることができます。

Get the start and end dates6.png

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

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、セッションおよびセッショングループのデータを含む、コースデータのリストが表示されます。セッションの開始日とび終了日は、CourseSessions の下の、それぞれStartDate と EndDate パラメータの隣に表示されます。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

Get the start and end dates7.png