| API名 |
講座分類一覧取得API |
| ID |
el_course_category_list_get_api |
2.詳細解説
講座分類の一覧情報を取得するAPI。INPUTには検索条件を設定します。
$cstream->call_el_course_category_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 |
|
講座分類ID |
course_category_id |
抽出に利用する講座分類ID（あいまい検索） |
|
| 5 |
|
講座分類名 |
course_category_name |
抽出に利用する講座分類名（あいまい検索） |
|
| 6 |
|
講座小分類ID |
course_small_category_id |
抽出に利用する講座小分類ID（あいまい検索） |
|
| 7 |
|
講座小分類名 |
course_small_category_name |
抽出に利用する講座小分類名（あいまい検索） |
|
OUTPUT
| No |
項目名 |
項目ID |
項目説明 |
| 1 |
|
実行フラグ |
exec_flg |
1:正常 9:エラー |
| 2 |
|
エラータイプ |
error_type |
実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 |
| 3 |
|
エラーメッセージ |
error_msg |
エラーごとに発生するメッセージ |
| 4 |
|
講座分類リスト |
course_category_list |
講座分類の一覧情報を取得 |
| |
4-1 |
講座分類ID |
course_category_id |
|
| |
4-2 |
講座分類名 |
course_category_name |
|
| |
4-3 |
講座分類解説 |
course_category_explain |
|
| 5 |
|
講座小分類リスト |
course_smaill_category_list |
講座小分類の一覧情報を取得 |
| |
5-1 |
講座分類ID |
course_category_id |
|
| |
5-2 |
講座小分類ID |
course_small_category_id |
|
| |
5-3 |
講座小分類名 |
course_small_category_name |
|
| |
5-4 |
講座小分類解説 |
course_small_category_explain |
|
エラー
| エラータイプ |
エラー概要 |
発生させるメッセージ |
発生させるException |
| 0 |
アクセスキー不適合エラー |
アクセスキーが適合しません。 |
AccessKeyException |
| 1 |
ホスト許可エラー |
対象のホストからのAPI実行を許可していません。 |
HostRestrictException |
| 2 |
引数エラー |
呼出パラメータが不足しているため実行できません。 |
CallParameterException |
| 9 |
システムメンテナンスエラー |
現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 |
SystemMaintenanceException |
4.実装例