| API名 |
継続決済IF情報取得API |
| ID |
el_monthlypayIFInfo_get_api |
2.詳細解説
継続決済IFの情報を取得するAPI。継続決済IFに登録されている受講者の一覧も取得することができる。
$cstream->call_el_monthlypayIFInfo_get_api($input_array);
3.I/O情報
INPUT
| No |
項目名 |
項目ID |
項目説明 |
必須 |
| 1 |
|
会社ID |
kaisha_id |
会社を表すID |
〇 |
| 2 |
|
アクセスキー |
access_key |
APIを認証するためのアクセスキー |
〇 |
| 3 |
|
継続決済IFID |
monthlypay_if_no |
抽出に利用する継続決済IFのID |
〇 |
| 4 |
|
受講者ID |
userid |
抽出に利用する受講者ID |
|
OUTPUT
| No |
項目名 |
項目ID |
項目説明 |
| 1 |
|
実行フラグ |
exec_flg |
1:正常 9:エラー |
| 2 |
|
エラータイプ |
error_type |
実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 |
| 3 |
|
エラーメッセージ |
error_msg |
エラーごとに発生するメッセージ |
| 4 |
|
継続決済IF名 |
monthlypay_if_name |
|
| 5 |
|
月額料金(税込) |
monthlypay_price_intax |
|
| 6 |
|
継続決済IF受講者情報 |
monthlypay_if_user |
useridを入れた場合に受講者情報を出力する。 |
| |
6-1 |
継続決済IF申込日 |
monthlypay_ap_date |
|
| |
6-2 |
継続決済IF退会日 |
monthlypay_quit_date |
|
| |
6-3 |
ステータス |
status |
|
エラー
| エラータイプ |
エラー概要 |
発生させるメッセージ |
発生させるException |
| 0 |
アクセスキー不適合エラー |
アクセスキーが適合しません。 |
AccessKeyException |
| 1 |
ホスト許可エラー |
対象のホストからのAPI実行を許可していません。 |
HostRestrictException |
| 2 |
引数エラー |
呼出パラメータが不足しているため実行できません。 |
CallParameterException |
| 9 |
システムメンテナンスエラー |
現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 |
SystemMaintenanceException |
4.実装例