| API名 | 講座一覧取得API |
| ID | el_course_list_get_api |
2.詳細解説
講座の一覧情報を取得するAPI。INPUTには検索条件を設定します。
検索条件により様々な利用用途に対応しています。具体的には以下のような場合に利用できます。
・ログインした受講者が受講可能な講座の一覧を取得する（INPUTに受講者IDを設定する）
・講座名、講座解説などからキーワード検索で講座を抽出する（INPUTに検索ワードを含める）
・人気講座（視聴が最も多い講座）、新着講座などの上位何件かを抽出する（INPUTの並び順と講座取得数を設定する）
$cstream->call_el_course_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になる） ※受講者IDを指定している場合、当該受講者が所属しているセクションが自動的に選択されるので、当該項目の入寮内容は無効になる |
||||||
| 4 | 講座ID | course_id | 抽出に利用する講座ID（=検索） | ||||||
| 5 | 講座名 | course_name | 抽出に利用する講座名（あいまい検索） ※OR検索可 | ||||||
| 6 | 講座分類ID | course_category_id | 抽出に利用する講座分類ID（=検索） | ||||||
| 7 | 講座分類名 | course_category_name | 抽出に利用する講座分類名（あいまい検索） ※OR検索可 | ||||||
| 8 | 講座小分類ID | course_small_category_id | 抽出に利用する講座小分類ID（=検索） | ||||||
| 9 | 講座小分類名 | course_small_category_name | 抽出に利用する講座小分類名（あいまい検索） ※OR検索可 | ||||||
| 10 | 講座解説 | course_explan | 抽出に利用する講座解説（あいまい検索） ※OR検索可 | ||||||
| 11 | 講座担当者名 | course_charge_name | 抽出に利用する講座担当者名（あいまい検索） ※OR検索可 | ||||||
| 12 | 連携項目１ | api_val_course1 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 13 | 連携項目２ | api_val_course2 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 14 | 連携項目３ | api_val_course3 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 15 | 連携項目４ | api_val_course4 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 16 | 連携項目５ | api_val_course5 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 17 | 連携項目６ | api_val_course6 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 18 | 連携項目７ | api_val_course7 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 19 | 連携項目８ | api_val_course8 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 20 | 連携項目９ | api_val_course9 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 21 | 連携項目１０ | api_val_course10 | 抽出に利用する連携項目名（あいまい検索） ※OR検索可 | ||||||
| 22 | 継続決済IFID | monthlypay_if_no | 抽出に利用する継続決済IFのID | ||||||
| 23 | カリキュラムID | course_group_id | 抽出に利用するカリキュラムID | ||||||
| 24 | 講座グループID | course_group_id | 抽出に利用する講座グループID | ||||||
| 25 | 受講ステータス | attend_status | NULL:なし 0:仮登録 1:本登録 9:キャンセル | ||||||
| 26 | 受講者ID | user_id | 受講者ID 受講ステータスを指定して抽出する場合必須 | △ | |||||
| 27 | 並び順 | sort_type | 0:講座ID昇順 1:新規登録順 2:視聴が多い順 3:表示順序順 4:最終更新順 |
〇 | |||||
| 28 | 取得講座数 | get_cnt | 取得する講座数。0が指定されている場合全講座を取得する。 | 〇 | |||||
注意：OR検索について
【現在記事内容をメンテナンス中】
OUTPUT
| No | 項目名 | 項目ID | 項目説明 | |||||
| 1 | 実行フラグ | exec_flg | 1:正常 9:エラー | |||||
| 2 | エラータイプ | error_type | 実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 | |||||
| 3 | エラーメッセージ | error_msg | エラーごとに発生するメッセージ | |||||
| 4 | 講座リスト | course_list | 講座の一覧情報を取得 | |||||
| 4-1 | 講座ID | course_id | ||||||
| 4-2 | 講座名 | course_name | ||||||
| 4-3 | 講座分類ID | course_category_id | ||||||
| 4-4 | 講座分類名 | course_category_name | ||||||
| 4-5 | 講座小分類ID | course_small_category_id | ||||||
| 4-6 | 講座小分類名 | course_small_category_name | ||||||
| 4-7 | 講座解説 | course_explan | ||||||
| 4-8 | 講座画像URL | course_pic_url | ||||||
| 4-9 | 受講時間目安 | lec_hours | ||||||
| 4-10 | 講座担当者名 | course_charge_name | ||||||
| 4-11 | 講座担当者メールアドレス | course_charge_mail | ||||||
| 4-12 | 料金 | price | ||||||
| 4-13 | 講義数 | lecture_cnt | ||||||
| 4-14 | 登録日時 | touroku_date | ||||||
| 4-15 | 更新日時 | koushin_date | ||||||
| 4-16 | 講座連携項目１ | api_val_course1 | ||||||
| 4-17 | 講座連携項目２ | api_val_course2 | ||||||
| 4-18 | 講座連携項目３ | api_val_course3 | ||||||
| 4-19 | 講座連携項目４ | api_val_course4 | ||||||
| 4-20 | 講座連携項目５ | api_val_course5 | ||||||
| 4-21 | 受講ステータス | attend_status | 0:仮登録 1:本登録 9:キャンセル ※受講者IDを指定した場合のみ表示 |
|||||
| 4-22 | 受講済講義数 | end_lecture_cnt | ※受講者IDを指定した場合のみ表示 | |||||
| 4-23 | 受講進捗度 | sintyoku | %表記。 受講済講義数/講義数 ×１００ 小数点切り上げ ※受講者IDを指定した場合のみ表示 | |||||
| 4-24 | 受講申込日 | course_ap_date | YYYYMMDD ※受講者IDを指定した場合のみ表示 | |||||
| 4-25 | 受講期限日 | course_end_date | YYYYMMDD ※受講者IDを指定した場合のみ表示 | |||||
| 4-26 | 講座並び順 | course_orderby | 講座の並び順を数字で表現 | |||||
| 4-27 | 講座受講者API連携項目１ | api_val_courseuser1 | ※受講者IDを指定した場合のみ表示 | |||||
| 4-28 | 講座受講者API連携項目２ | api_val_courseuser2 | ※受講者IDを指定した場合のみ表示 | |||||
| 4-29 | 講座受講者API連携項目３ | api_val_courseuser3 | ※受講者IDを指定した場合のみ表示 | |||||
| 4-30 | 講座受講者API連携項目４ | api_val_courseuser4 | ※受講者IDを指定した場合のみ表示 | |||||
| 4-31 | 講座受講者API連携項目５ | api_val_courseuser5 | ※受講者IDを指定した場合のみ表示 | |||||
エラー
| エラータイプ | エラー概要 | 発生させるメッセージ | 発生させるException | ||||||
| 0 | アクセスキー不適合エラー | アクセスキーが適合しません。 | AccessKeyException | ||||||
| 1 | ホスト許可エラー | 対象のホストからのAPI実行を許可していません。 | HostRestrictException | ||||||
| 2 | 引数エラー | 呼出パラメータが不足しているため実行できません。 | CallParameterException | ||||||
| 9 | システムメンテナンスエラー | 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 | SystemMaintenanceException | ||||||
4.実装例
|
1 |