lms-他システム連携/API

13-03-28.商品一覧取得API

投稿日:

API名 商品一覧取得API
ID el_productList_get_api

2.詳細解説

商品情報を一覧取得するAPIです。商品に紐づく講座等(講座グループ、カリキュラム含む)のリストは取得できません。商品のリストを取得したい場合利用しますが、さらに詳細な情報を取得したい場合、el_productInfo_get_api を併用してください。

$cstream->call_el_productList_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   商品ステータス product_status 商品の状況(0:設定未了 1:有効 9:削除) 通常は1を指定してください

OUTPUT

No 項目名 項目ID 項目説明
1 実行フラグ exec_flg 1:正常 9:エラー
2 エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3 エラーメッセージ error_msg エラーごとに発生するメッセージ
4 エラー情報 error_info エラーメッセージを表示(登録に失敗したケース)
5 商品ID product_id  
6 商品名 product_name  
7 販売種別 sales_type  
8 有効期間from valid_date_from  
9 有効期間to valid_date_to  
10 支払方法フラグ_銀行 payment_flg_furikomi  
11 支払方法フラグ_クレジット payment_flg_credit  
12 支払方法フラグ_コンビニ payment_flg_conveni  
13 税込料金 price_intax  
14 商品画像URL product_pic_url  
15 備考 bikou  
16 無料新規申込時メッセージID free_ap_new_message_id  
17 銀行振込新規申込時メッセージID bank_ap_new_message_id  
18 クレジット新規申込時メッセージID credit_ap_new_message_id  
19 コンビニ決済新規申込時メッセージID conveni_ap_new_message_id  
20 無料既存申込時メッセージID free_ap_kizon_message_id  
21 銀行振込既存申込時メッセージID bank_ap_kizon_message_id  
22 クレジット既存申込時メッセージID credit_ap_kizon_message_id  
23 コンビニ決済既存申込時メッセージID conveni_ap_kizon_message_id  
24 一括申込時受講者通知メッセージID lotsell_ap_user_tuuchi_message_id  
25 商品ステータス product_status  
26 連携項目1 api_val_product1  
27 連携項目2 api_val_product2  
28 連携項目3 api_val_product3  
29 連携項目4 api_val_product4  
30 連携項目5 api_val_product5  

エラー

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