lms-他システム連携/API

13-03-7.講座グループ個別取得API

更新日:

API名 講座グループ個別取得API
ID el_courseGroup_kobetsu_get_api

2.詳細解説

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

$cstream->call_el_courseGroup_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になる)  
4   講座グループID course_group_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_group_info 講座グループの個別情報を取得
  4-1 講座グループID course_group_id  
  4-2 講座グループ名 course_group_name  
  4-3 講座グループ解説 course_group_explan  
  4-4 講座グループ画像URL course_group_pic_url  
  4-5 講座数 course_cnt  
  4-6 受講ステータス attend_status 0:仮登録 1:本登録 9:キャンセル 
※講座グループ受講者Tに情報がない場合NULL
  4-7 受講進捗度 sintyoku %表記。 受講済講義数/全講義数 ×100 小数点切り上げ
  4-8 受講期限日 course_end_date YYYYMMDD ※講座グループ受講者Tに情報がない場合NULL
  4-9 連携項目1 api_val_coursegroup1  
  4-10 連携項目2 api_val_coursegroup2  
  4-11 連携項目3 api_val_coursegroup3  
  4-12 連携項目4 api_val_coursegroup4  
  4-13 連携項目5 api_val_coursegroup5  
  4-14 登録日時 touroku_date  
  4-15 更新日時 koushin_date  
5   講座リスト course_list 講座グループに所属する講座の一覧情報を取得
  5-1 講座ID course_id  
  5-2 講座名 course_name  
  5-3 講座表示順序 course_orderby  
5-4 講座分類ID course_category_id
  5-5 講座分類名 course_category_name  
5-6 講座小分類ID course_small_category_id
5-7 講座小分類名 course_small_category_name
  5-8 講座画像URL course_pic_url  
  5-9 受講時間目安 lec_hours  
  5-10 講座担当者名 course_charge_name  
  5-11 講義数 lecture_cnt  
  5-12 連携項目1 api_val_course1  
  5-13 連携項目2 api_val_course2  
  5-14 連携項目3 api_val_course3  
  5-15 連携項目4 api_val_course4  
  5-16 連携項目5 api_val_course5  
5-17 連携項目6 api_val_course6
5-18 連携項目7 api_val_course7
5-19 連携項目8 api_val_course8
5-20 連携項目9 api_val_course9
5-21 連携項目10 api_val_course10

エラー

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