| API名 | 講義情報取得API |
| ID | el_course_lecture_get_api |
2.詳細解説
講座を指定し、講義の情報を取得するAPI。
$cstream->call_el_course_lecture_get_api($input_array);
3.I/O情報
INPUT
| No | 項目名 | 項目ID | 項目説明 | 必須 | |||||
| 1 | 会社ID | kaisha_id | 会社を表すID | 〇 | |||||
| 2 | アクセスキー | access_key | APIを認証するためのアクセスキー | 〇 | |||||
| 3 | 講座ID | course_id | 抽出に利用する講座ID（=検索） | 〇 | |||||
| 4 | 講義ID | lecture_id | 抽出に利用する講義ID（=検索） | ||||||
| 5 | 講義種類 | lecture_type | 0:動画配信型 1:問題出題型 2:スライド配信型 3:スライド＆動画配信型 4:ライブ配信型 5:アンケート 6:課題提出型講義 |
||||||
| 6 | 受講者ID | user_id | 受講者ID 受講URL取得時は必須 | △ | |||||
OUTPUT
| No | 項目名 | 項目ID | 項目説明 | |||||
| 1 | 実行フラグ | exec_flg | 1:正常 9:エラー | |||||
| 2 | エラータイプ | error_type | 実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 | |||||
| 3 | エラーメッセージ | error_msg | エラーごとに発生するメッセージ | |||||
| 4 | 講義リスト | lecture_list | 講義の一覧情報を取得 | |||||
| 4-1 | 講義ID | lecture_id | ||||||
| 4-2 | 講義行番号 | lecture_row_no | ||||||
| 4-3 | 講義名 | lecture_name | ||||||
| 4-4 | 講義種類 | lecture_type | ||||||
| 4-5 | 講義分類ID | lecture_category_id | ||||||
| 4-6 | 講義分類名 | lecture_category_id | ||||||
| 4-7 | 講義解説 | lecture_explan | ||||||
| 4-8 | 講義表示フラグ | view_flg | ||||||
| 4-9 | 講義受講時間 | lecture_time | X分。受講講座個別画面と同様のロジックで取得。 | |||||
| 4-10 | 講義受講状況 | lecture_status | 受講者IDを指定しているときのみ出力。 0:受講前 1:視聴中 2:視聴完了 3:問題解答完了 4:正答率達成 |
|||||
| 4-11 | 動画サムネイルURL | movie_thumbnail_url | 動画配信型、スライド動画配信型の場合取得 | |||||
| 4-12 | 講義添付ファイルURL１ | attached_doc_1_url | ||||||
| 4-13 | 講義添付ファイルURL２ | attached_doc_2_url | ||||||
| 4-14 | 講義添付ファイルURL３ | attached_doc_3_url | ||||||
| 4-15 | 連携項目１ | api_val_lecture1 | ||||||
| 4-16 | 連携項目２ | api_val_lecture2 | ||||||
| 4-17 | 連携項目３ | api_val_lecture3 | ||||||
| 4-18 | 連携項目４ | api_val_lecture4 | ||||||
| 4-19 | 連携項目５ | api_val_lecture5 | ||||||
エラー
| エラータイプ | エラー概要 | 発生させるメッセージ | 発生させるException | ||||||
| 0 | アクセスキー不適合エラー | アクセスキーが適合しません。 | AccessKeyException | ||||||
| 1 | ホスト許可エラー | 対象のホストからのAPI実行を許可していません。 | HostRestrictException | ||||||
| 2 | 引数エラー | 呼出パラメータが不足しているため実行できません。 | CallParameterException | ||||||
| 9 | システムメンテナンスエラー | 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 | SystemMaintenanceException | ||||||
4.実装例
|
1 |