lms-他システム連携/API

13-03-14.受講権限編集API

更新日:

API名 受講権限編集API 
ID el_userAuth_upd_api

2.詳細解説

特定の受講者に対して権限を付与したり、付与した権限を解除したり、権限の有効期限を変更することができるAPIです。主に会員登録機能などで、受講者情報編集APIとともに利用されます。

$cstream->call_el_userAuth_upd_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   受講者ID userid  
4   更新種類 upd_type 0:権限の追加更新 1:受講期限日、ステータスの更新 2:API連携項目の更新
5   権限リスト auth_list 1つ以上必須
  5-1 講座ID course_id 権限を付与する講座等のID 具体的には以下マスタに対応している
 ・講座 ・講座グループ ・カリキュラム ・継続決済IF
  5-2 受講申込日 course_ap_date 受講申込日(YYYYMMDD)
更新種類:0の場合必須
  5-3 受講期限日 course_end_date 受講期限日(YYYYMMDD)
入力しない場合講座または講座グループで指定した期限の計算方法により自動的に算出される。
 
  5-4 受講ステータス attend_status 0:仮登録 1:本登録 9:キャンセル
更新種類:0,1の場合必須
5-5 API連携項目1 api_val_courseuser1 講座権限に対して付与できる連携項目。更新種類0かつ講座IDに「講座」を指定した場合のみ有効。
5-6  API連携項目2 api_val_courseuser2 講座権限に対して付与できる連携項目。更新種類0かつ講座IDに「講座」を指定した場合のみ有効。
5-7  API連携項目3 api_val_courseuser3 講座権限に対して付与できる連携項目。更新種類0かつ講座IDに「講座」を指定した場合のみ有効。
5-8  API連携項目4 api_val_courseuser4 講座権限に対して付与できる連携項目。更新種類0かつ講座IDに「講座」を指定した場合のみ有効。
5-9  API連携項目5 api_val_courseuser5 講座権限に対して付与できる連携項目。更新種類0かつ講座IDに「講座」を指定した場合のみ有効。

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   エラー情報 error_info エラーメッセージを表示(登録に失敗したケース)
  4-1 講座ID course_id  
  4-2 受講申込日 course_ap_date  
  4-3 受講期限日 course_end_date  
  4-4 支払方法区分 payment_kbn  
  4-5 オーダーNo order_no  
  4-6 受講ステータス attend_status  

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
3 登録エラー 登録が失敗しました AddDataException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.