割引履歴情報取得API

マーケティングプラットフォームの割引履歴情報を参照するためのAPIです。

メソッド名

visitor.getDiscounthistory

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/visitor/discounthistory

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
VisitorId	○	×	リードID
ApplicationId	○	○	申込履歴ID
DiscountId	○	○	割引ID
DiscountDate	○	○	割引日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：DiscountHistory ★ データ型：DiscountHistoryType

カラム名	データ型	内容
Id	string	割引ID
VisitorId	string	リードID
ApplicationId	string	申込履歴ID
DiscountId	string	割引ID
DiscountDate	dateTime	割引日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<DiscountHistoryList xmlns="http://smartseminar.jp/" version="1.5">
　<DiscountHistory>
　　<Id>1</Id>
　　<VisitorId>1</VisitorId>
　　<ApplicationId>1</ApplicationId>
　　<DiscountId>1</DiscountId>
　　<DiscountDate>2009-10-19T12:14:44+0900</DiscountDate>
　</DiscountHistory>
</DiscountHistoryList>

制限事項

なし