lms-他システム連携/API

13-03-3.講座グループ一覧取得API

更新日:

API名 講座グループ一覧取得API
ID el_courseGroup_list_get_api

2.詳細解説

講座グループの一覧情報を取得するAPI。INPUTには検索条件を設定します。
検索条件により様々な利用用途に対応しています。具体的には以下のような場合に利用できます。

・ログインした受講者が受講可能な講座グループの一覧を取得する(INPUTに受講ステータス1、受講者IDを設定する)
・継続決済IFに含まれる講座グループを取得する(継続決済IF番号を含める)

$cstream->call_el_courseGroup_list_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   継続決済IFID monthlypay_if_no 抽出に利用する継続決済IFのID  
5   講座グループID course_group_id 抽出に利用する講座グループID  
6   講座グループ名 course_group_name 抽出に利用する講座グループ名(あいまい検索)  
7   講座ID course_id 抽出に利用する講座ID(=検索)  
8   連携項目1 api_val_coursegroup1 抽出に利用する連携項目名(あいまい検索)  
9   連携項目2 api_val_coursegroup2 抽出に利用する連携項目名(あいまい検索)  
10   連携項目3 api_val_coursegroup3 抽出に利用する連携項目名(あいまい検索)  
11   連携項目4 api_val_coursegroup4 抽出に利用する連携項目名(あいまい検索)  
12   連携項目5 api_val_coursegroup5 抽出に利用する連携項目名(あいまい検索)  
13   受講ステータス attend_status NULL:なし 0:仮登録 1:本登録 9:キャンセル   
14   受講者ID user_id 受講者ID 受講ステータスを指定して抽出する場合必須
15   取得講座グループ数 get_cnt 取得する講座グループ数。0が指定されている場合全講座グループを取得する。

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   講座グループリスト course_group_list 講座グループの一覧情報を取得
  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 連携項目1 api_val_coursegroup1  
  4-7 連携項目2 api_val_coursegroup2  
  4-8 連携項目3 api_val_coursegroup3  
  4-9 連携項目4 api_val_coursegroup4  
  4-10 連携項目5 api_val_coursegroup5  
  4-11 登録日時 touroku_date  
  4-12 更新日時 koushin_date  
  4-13 受講ステータス attend_status 0:仮登録 1:本登録 9:キャンセル 
※講座グループ受講者Tに情報がない場合NULL
  4-14 受講進捗度 sintyoku %表記。 受講済講義数/講義数 ×100 小数点切り上げ
  4-15 受講申込日 course_ap_date YYYYMMDD ※講座グループ受講者Tに情報がない場合NULL
  4-16 受講期限日 course_end_date YYYYMMDD ※講座グループ受講者Tに情報がない場合NULL

エラー

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