lms-他システム連携/API

13-03-5.受講状況取得API

更新日:

API名 受講状況取得API
ID el_user_record_get_api

2.詳細解説

受講者の講座(講座グループ/カリキュラム)の受講状況を取得するAPI。取得できる情報はLMSの受講状況確認機能と同じです。詳しくはこちらをご覧ください。

$cstream->call_el_user_record_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   抽出単位 pickup_layer 0:講座グループ単位 1:講座単位 2:講義単位 3:カリキュラム
4   抽出条件 pickup_joken 0:すべて取得 1:受講進捗があるもののみ取得
5   受講者ID user_id 受講者ID
6   講座グループID course_group_id 抽出に利用する講座グループID  
7   カリキュラムID curriculum_id 抽出に利用するカリキュラムID  
8   講座ID course_id 抽出に利用する講座ID  
9   並び順 sort_type 0:講座ID昇順 1:最新再生開始時間順 2:視聴が多い順
10   取得情報数 get_cnt 取得する情報数。0が指定されている場合全情報を取得する。

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   講座グループ単位受講状況リスト course_group_record_list 講座グループ単位の受講状況を取得
  4-1 講座グループID course_group_id  
  4-2 講座グループ名 course_group_name  
  4-3 講座グループ画像URL course_group_pic_url  
  4-4 講座数 course_cnt  
  4-5 完了講座数 end_course_cnt  
  4-6 受講進捗度 sintyoku  
  4-7 受講完了日 course_group_comp_date MAX(履歴.再生開始時間) YYYYMMDDHHIISS
5   講座単位受講状況リスト course_record_list 講座単位の受講状況を取得
  5-1 講座ID course_id  
  5-2 講座名 course_name  
  5-3 講座画像URL course_pic_url  
  5-4 講義数 lecture_cnt  
  5-5 開始講義数 start_lecture_cnt  
  5-6 完了講義数 end_lecture_cnt  
  5-7 受講進捗度 sintyoku  
  5-8 最新再生開始時間 new_play_start_time MAX(履歴.再生開始時間) YYYYMMDDHHIISS
  5-9 合計視聴時間 sum_play_time SUM(履歴.再生開始時間) HH:MM:SSで出力
5-10 合計スライドPV数 slide_pv_sum
6   講義単位受講状況リスト lecture_record_list 講義単位の受講状況を取得
  6-1 講座ID course_id  
  6-2 講座名 course_name  
  6-3 講座画像URL course_pic_url  
  6-4 講義ID lecture_id  
  6-5 講義名 lecture_name  
  6-6 進捗状況 sintyoku_jokyo 受講前 受講開始 視聴完了 問題解答完了 正答率達成
  6-7 最新再生開始時間 new_play_start_time MAX(履歴.再生開始時間) YYYYMMDDHHIISS
  6-8 合計視聴時間 sum_play_time SUM(履歴.再生開始時間) HH:MM:SSで出力
6-9 合計スライドPV数 slide_pv_sum
6-10 問題解答回数 exam_answer_cnt
6-11 最高正答率 max_per_correct_answer
7   カリキュラム単位受講状況リスト curriculum_record_list カリキュラム単位の受講状況を取得
  7-1 カリキュラムID curriculum_id  
  7-2 カリキュラム名 curriculum_name  
  7-3 受講状況 attend_jokyo_kbn 未受講 / 受講中 / 合格
  7-4 完了フェーズ数 end_phase_count 受講が完了したフェーズ数
  7-5 全フェーズ数 phase_count  
  7-6 獲得点数 curriculum_end_score  
  7-7 合格点数 pass_standard_score  
  7-8 合計点数 curriculum_total_score  
  7-9 合格日時 curriculum_comp_date 獲得点数が合格点数を超えた日付(YYYYMMDD)

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させる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.