lms-他システム連携/API

13-03-8.講座個別取得API

更新日:

API名 講座個別取得API
ID el_course_kobetsu_get_api

2.詳細解説

講座を指定し、講座の詳細情報(紐づく講義情報も含む)を取得するAPI。

$cstream->call_el_course_kobetsu_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   セクションID section_id マスタの所属または共有セクション(入力しないとRootセクションのIDになる)
※受講者IDを指定している場合、当該受講者が所属しているセクションが自動的に選択されるので、当該項目の入寮内容は無効になる
 
4   講座ID course_id 抽出に利用する講座ID(=検索)
5   受講ステータス attend_status NULL:なし 0:仮登録 1:本登録 9:キャンセル   
6   受講者ID user_id 受講者ID 受講ステータスを指定して抽出する場合必須

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   講座個別情報 course_info 講座の個別情報を取得
  4-1 講座ID course_id  
  4-2 講座名 course_name  
  4-3 セクションID section_id 講座の所属セクションID
  4-4 セクション名 section_name 講座の所属セクション名
4-5 講座分類ID course_category_id
  4-5 講座分類名 course_category_name  
4-6 講座小分類ID course_small_category_id
  4-7 講座小分類名 course_small_category_name  
  4-8 講座解説 course_explan  
  4-9 講座画像URL course_pic_url  
  4-10 講座添付ファイルURL course_file_url  
  4-11 受講時間目安 lec_hours  
  4-12 講座担当者名 course_charge_name  
4-13 講座担当者メールアドレス course_charge_mail
  4-14 講義数 lecture_cnt  
  4-15 登録日時 touroku_date  
  4-16 更新日時 koushin_date  
  4-17 受講ステータス attend_status 0:仮登録 1:本登録 9:キャンセル 
※講座受講者Tに情報がない場合NULL
  4-18 受講済講義数 end_lecture_cnt ※講座受講者Tに情報がない場合NULL
  4-19 受講進捗度 sintyoku %表記。 受講済講義数/講義数 ×100 小数点切り上げ
  4-20 受講期限日 course_end_date YYYYMMDD ※講座受講者Tに情報がない場合NULL
  4-21 講座連携項目1 api_val_course1  
  4-22 講座連携項目2 api_val_course2  
  4-23 講座連携項目3 api_val_course3  
  4-24 講座連携項目4 api_val_course4  
  4-25 講座連携項目5 api_val_course5  
4-26 講座受講者API連携項目1 api_val_courseuser1 ※受講者IDを指定した場合のみ表示
4-27 講座受講者API連携項目2 api_val_courseuser2 ※受講者IDを指定した場合のみ表示
4-28 講座受講者API連携項目3 api_val_courseuser3 ※受講者IDを指定した場合のみ表示
4-29 講座受講者API連携項目4 api_val_courseuser4 ※受講者IDを指定した場合のみ表示
4-30 講座受講者API連携項目5 api_val_courseuser5 ※受講者IDを指定した場合のみ表示
5   講義リスト lecture_list 講座に所属する講義の一覧情報を取得
  5-1 講義ID lecture_id  
  5-2 講義行番号 lecture_row_no  
  5-3 講義名 lecture_name  
  5-4 講義種類 lecture_type 0:動画配信型 1:問題出題型 2:スライド配信型 3:スライド&動画配信型 4:ライブ配信型 5:アンケート 6:課題提出型講義
  5-5 講義分類ID lecture_category_id  
  5-6 講義分類名 lecture_category_id  
  5-7 講義解説 lecture_explan  
  5-8 動画サムネイルURL movie_thumbnail_url 動画配信型、スライド動画配信型の場合取得
  5-9 問題機能使用フラグ exam_func_use_flg  
  5-10 出題方法区分 propose_plan_kbn  
  5-11 採点方法区分 score_plan_kbn  
  5-12 出題数 propose_num  
  5-13 解答制限回数 answer_limit_cnt  
  5-14 解答制限時間 answer_limit_time  
  5-15 受講完了条件区分 lec_end_joken_kbn  
  5-16 正答率 per_correct_answer  
5-17 課題評価者ID task_reviewer_userid 課題評価者の受講者ID
5-18 課題提出期限日数 task_submit_enddate_cnt 課題の提出期限を、受講期限日のX日前までとするか。
  5-19 講義表示フラグ view_flg  
  5-20 講義受講時間 lecture_time X分。受講講座個別画面と同様のロジックで取得。
  5-21 講義連携項目1 api_val_lecture1  
  5-22 講義連携項目2 api_val_lecture2  
  5-23 講義連携項目3 api_val_lecture3  
  5-24 講義連携項目4 api_val_lecture4  
  5-25 講義連携項目5 api_val_lecture5  
5-26 講義連携項目6 api_val_lecture6
5-27 講義連携項目7 api_val_lecture7
5-28 講義連携項目8 api_val_lecture8
5-29 講義連携項目9 api_val_lecture9
5-30 講義連携項目10 api_val_lecture10
  5-31 講義受講状況 lecture_status 受講者IDを指定しているときのみ出力。
0:受講前 1:視聴中 2:視聴完了 3:問題解答完了 4:正答率達成 5:課題提出 6:課題レビュー完了 7:課題合格
6   講師リスト lecturer_list 講座の担当権限をもつ講師アカウントのリスト
  6-1 受講者ID userid  
  6-2 受講者氏名 username  
  6-3 受講者氏名(カナ) usernamekana  
  6-4 メールアドレス mail  
  6-5 法人名 incName  
  6-6 部署名 departName  
  6-7 役職 position  
  6-8 任意項目 other  
  6-9 連携項目1 api_val_user1  
  6-10 連携項目2 api_val_user2  
  6-11 連携項目3 api_val_user3  
  6-12 連携項目4 api_val_user4  
  6-13 連携項目5 api_val_user5  
  6-14 受講者ステータス user_status  

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.