| API名 |
採番API |
| ID |
el_numbering_api |
2.詳細解説
継続決済IFを使った登録をする際に、会員IDをGMO社に渡す必要があり、事前に受講者IDを採番する必要がある。その場合に利用するAPI。
$cstream->call_el_numbering_api($input_array);
3.I/O情報
INPUT
| No |
項目名 |
項目ID |
項目説明 |
必須 |
| 1 |
|
会社ID |
kaisha_id |
会社を表すID |
〇 |
| 2 |
|
アクセスキー |
access_key |
APIを認証するためのアクセスキー |
〇 |
| 3 |
|
採番種類 |
numbering_type |
採番の種類。userid(受講者ID)、movie_id(動画ID）、text_id(電子テキストID) |
〇 |
OUTPUT
| No |
項目名 |
項目ID |
項目説明 |
| 1 |
|
実行フラグ |
exec_flg |
1:正常 9:エラー |
| 2 |
|
エラータイプ |
error_type |
実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 |
| 3 |
|
エラーメッセージ |
error_msg |
エラーごとに発生するメッセージ |
| 4 |
|
エラー情報 |
error_info |
エラーメッセージを表示（登録に失敗したケース） |
| |
4-1 |
最新番号 |
last_number |
採番種類で指定したIDの最新番号 |
エラー
| エラータイプ |
エラー概要 |
発生させるメッセージ |
発生させるException |
| 0 |
アクセスキー不適合エラー |
アクセスキーが適合しません。 |
AccessKeyException |
| 1 |
ホスト許可エラー |
対象のホストからのAPI実行を許可していません。 |
HostRestrictException |
| 2 |
引数エラー |
呼出パラメータが不足しているため実行できません。 |
CallParameterException |
| 3 |
採番種類エラー |
存在しない採番種類です |
|
| 9 |
システムメンテナンスエラー |
現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 |
SystemMaintenanceException |
4.実装例