| API名 |
退会API |
| ID |
el_quit_api |
2.詳細解説
受講者を退会させるAPI。受講者情報編集APIで受講者ステータスを９（削除）に更新した場合と同様だが、退会APIを実行するとLMSの退会通知メールが対象者に送信されるところが異なる。
$cstream->call_el_quit_api($input_array);
3.I/O情報
INPUT
| No |
項目名 |
項目ID |
項目説明 |
必須 |
| 1 |
|
会社ID |
kaisha_id |
会社を表すID |
〇 |
| 2 |
|
アクセスキー |
access_key |
APIを認証するためのアクセスキー |
〇 |
| 3 |
|
受講者ID |
userid |
|
〇 |
| 4 |
|
退会理由 |
quit_reason |
|
〇 |
OUTPUT
| No |
項目名 |
項目ID |
項目説明 |
| 1 |
|
実行フラグ |
exec_flg |
1:正常 9:エラー |
| 2 |
|
エラータイプ |
error_type |
実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 |
| 3 |
|
エラーメッセージ |
error_msg |
エラーごとに発生するメッセージ |
| 4 |
|
エラー情報 |
error_info |
エラーメッセージを表示（登録に失敗したケース） |
| |
4-1 |
受講者ID |
userid |
|
| |
4-2 |
退会理由 |
quit_reason |
|
エラー
| エラータイプ |
エラー概要 |
発生させるメッセージ |
発生させるException |
| 0 |
アクセスキー不適合エラー |
アクセスキーが適合しません。 |
AccessKeyException |
| 1 |
ホスト許可エラー |
対象のホストからのAPI実行を許可していません。 |
HostRestrictException |
| 2 |
引数エラー |
呼出パラメータが不足しているため実行できません。 |
CallParameterException |
| 3 |
登録エラー |
登録が失敗しました |
AddDataException |
| 9 |
システムメンテナンスエラー |
現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 |
SystemMaintenanceException |
4.実装例