割引情報取得API

SMPの割引情報を参照するためのAPIです。

メソッド名

seminar.getDiscount

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/seminar/discount

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
order	オプション	並び順の項目指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照
direction	オプション	並び順を指定する「asc」（昇順）または「desc」（降順）
limit	オプション	1回のリクエストで取得するレコード数（最大1000）
offset	オプション	レコードのオフセット

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Id	○	○	割引ID
DiscountTypeId	○	○	割引種別 1：キャンペーンコード割引 2：自動割引 3：複数購入割引
SeminarId	○	○	キャンペーン
Name	○	○	割引名
Code	○	○	割引コード
DiscountPrice	○	○	割引金額
DiscountPercent	○	○	割引率
LimitUserNum	○	○	割引制限回数
Use	○	○	用途
Memo	○	○	メモ
LimitDate	○	○	割引期限日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Discount ★ データ型：DiscountType

カラム名	データ型	内容
Id	string	割引ID
DiscountType	DiscountTypeType	割引種別 DiscountTypeId：DiscountTypeName 1：キャンペーンコード割引 2：自動割引 3：複数購入割引
Seminar	SeminarRefType	キャンペーン SeminarId：SeminarName キャンペーンID ：キャンペーン名
Name	string	割引名
Code	string	割引コード
DiscountPrice	nonNegativeInteger	割引金額
DiscountPercent	float	割引率
LimitUserNum	nonNegativeInteger	割引制限回数
Use	string	用途
Memo	string	メモ
LimitDate	dateTime	割引期限日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
NumberOfUser	nonNegativeInteger	使用ユーザー数

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<DiscountList xmlns="http://smartseminar.jp/" version="1.5">
　<Discount>
　　<Id>1</Id>
　　<DiscountType>
　　　<DiscountTypeId>1</DiscountTypeId>
　　　<DiscountTypeName>キャンペーンコード割引</DiscountTypeName>
　　</DiscountType>
　　<Seminar>
　　　<SeminarId>1</SeminarId>
　　　<SeminarName>テストキャンペーン</SeminarName>
　　</Seminar>
　　<Name>コード割引～その1～</Name>
　　<Code>WARIBIKI</Code>
　　<DiscountPrice>2000</DiscountPrice>
　　<DiscountPercent>10</DiscountPercent>
　　<LimitUserNum>20</LimitUserNum>
　　<Use>割引コード</Use>
　　<Memo>これはメモ欄</Memo>
　　<LimitDate>2009-10-30T20:20:10+0900</LimitDate>
　　<DateRegist>2009-10-16T22:56:24+0900</DateRegist>
　　<DateUpdate>2009-10-16T22:56:24+0900</DateUpdate>
　　<NumberOfUser>2</NumberOfUser>
　</Discount>
</DiscountList>

制限事項

なし