ここでは、Learn365 API を通じたコースセッション 開始日と終了日の取得について説明します。
API を通じたコースセッション 開始日と終了日の取得は、コース ID、セッション ID を用いて行う場合と、そうでない場合とで異なるエンドポインを使用します。
コース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”(コースセッションのデータがレスポンスに含まれることになります。)
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
- Response body には、パラメータで指定さしたIDのコースとそのセッション/ セッション グループのデータのみが含まれます。
- Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。
- 単独セッションとセッション グループ内のセッションの開始日と終了日は、それぞれ対応するパラメータの後ろに記述されます。
-
- セッショングループ(IsGroupが”true”)の場合、StartDate と EndDate パラメータの値は、それぞれ常に「1753-01-01T00:00:00Z」と「9999-12-31T23:59:59.997Z」になります。セッション グループには開始日と終了日はなく、セッションだけが指定された日付を持ちます。
セッションID を用いる場合
セッション 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.パラメータ セクションで、フィールドに以下の値を入力します。
- Id*:セッションの開始日と終了日を取得するセッション ID(このフィールドは入力必須です。)
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
- Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。
- Response body には、開始日と終了日を含む、この特定のセッションに関連するデータが表示されます。
コース/ セッション ID を用いない場合
コースまたはセッション ID を用いない場合、セッション 開始日と終了日の取得は、以下の手順に沿って行います。
1.https://api.365.systems/ にアクセスし、APIキーで認証します。
2.Courses セクションを展開し、GET /odata/v2/Courses Returns the Course by Id を選択し、右上の「Try it out」を選択します。
3.さまざまなクエリ オプション パラメータを設定して レスポンス データを絞り込むことができます。
例: $expand フィールドに「CourseSessions」と入力します。その結果、レスポンスにはセッションデータを含むテナントのコースが含まれます。
|
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
- Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。
- Response body には、セッションおよびセッショングループのデータを含む、コース データのリストが表示されます。セッションの開始日とび終了日は、CourseSessions の下の、それぞれStartDate と EndDate パラメータの後ろに記述されます。