lms-他システム連携/API

13-03-29.Q&A一覧取得API

更新日:

API名 Q&A一覧取得API
ID el_qaList_get_api

2.詳細解説

Q&A情報を一覧取得するAPIです。質問や回答の中身までは取得できません。質問のリストを取得したい場合利用しますが、さらに詳細な情報を取得したい場合、el_qaInfo_get_api を併用してください。

$cstream->call_el_qaList_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   質問/回答区分 question_answer_kbn 0:質問 1:解答
5   講座ID course_id 抽出に利用する講座ID(=検索)
6   受講者ID(質問者) userid  
7   受講者ID(回答者) lecturer_userid  
         

OUTPUT

No 項目名 項目ID 項目説明
1 実行フラグ exec_flg 1:正常 9:エラー
2 エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3 エラーメッセージ error_msg エラーごとに発生するメッセージ
4 エラー情報 error_info エラーメッセージを表示(登録に失敗したケース)
5 qa_info  Q&A情報を設定
5-1 受講者ID(質問者) userid  
5-2 受講者氏名(質問者) username  
5-3 QA番号 qa_no  
5-4 QA枝番号 qa_row_no  
5-5 QA区分 qa_kbn  0:質問 1:解答
5-6 既読フラグ read_flg  0:未読 1:既読
5-7 講座ID course_id  
5-8 講座名 course_name  
5-9 講義ID lecture_id  
5-10 講義名 lecture_name  
5-11 受講者ID(回答者) lecturer_userid  
5-12 受講者氏名(回答者) lecturer_username  
5-13 管理者ID(回答者) manager_id  
5-14 管理者氏名(回答者) manager_name  
5-15 初回質問日 first_qa_date  
5-16 QAタイトル qa_title  
5-17 承認フラグ approval_flg  0:未承認 1:承認済
5-18 回答ステータス answer_status  0:一時保存 1:有効
5-19 登録日時 touroku_date  質問(回答)の登録日時(YYYYMMDDHHIISS)

エラー

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