申込情報取得API

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

メソッド名

visitor.getApplication

リクエスト情報

アクセスURL

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

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
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	○	×	リードID
ApplicationFlowId	○	×	フロー
PaymentFlag	○	○	入金フラグ
LanguageId	○	×	登録時言語
CommonTransactionCode ※非推奨カラムです。	×	×	請求CODE(全キャンペーン共通)
SeminarTransactionCode ※非推奨カラムです。	×	×	請求CODE
CommonVisitorCode ※非推奨カラムです。	×	×	リードCODE（全キャンペーン共通）
SeminarVisitorCode ※非推奨カラムです。	×	×		リードCODE
PaymentMemo	○	○	支払メモ
PaymentResult	○	○	取引結果
PaymentError	○	○	取引エラー内容
CreditStatus	○	○	クレジット決済ステータス
PaymentOrderId	○	○	取引ID
EnqueteDataId	○	○	アンケート回答情報ID ※マーケティングプラットフォームに登録されているアンケート回答情報に割り当てられるユニークな数字です。

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Transaction ★ データ型：TransactionType

カラム名	データ型	内容
Id	string	申込ID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	string	リードID
ApplicationFlow	ApplicationFlowRefType	フロー ApplicationFlowId：ApplicationFlowName フローID：フロー名
EnqueteDataId	string	アンケート回答情報ID ※マーケティングプラットフォームに登録されているアンケート回答情報に割り当てられるユニークな数字です。
PaymentFlag	PaymentFlagType	入金フラグ PaymentFlagId：PaymentFlagName 0：未入金 1：入金済み 2：確認中
PaymentType	PaymentTypeType	支払方法 PaymentTypeId：PaymentTypeName 1：クレジットカード決済 2：銀行振込 3：コンビニ決済 4：無料 5：ペイジー決済(Pay-Easy) 6：コンビニ決済(セブンイレブン) 7：コンビニ決済(ローソン・セイコーマート・ミニストップ) 8：コンビニ決済(ファミリーマート) 9：コンビニ決済(サークルKサンクス・デイリーヤマザキ等、その他)
Price	nonNegativeInteger	割引前金額
DiscountPrice	nonNegativeInteger	割引後金額
CancelParentId	string	キャンセルの対象となる申込ID
CancelFlag	nonNegativeInteger	値なし:申込 1:キャンセル
BillingId	string	請求先ID
Language	LanguageType	登録時言語 LanguageId：LanguageName 1：日本語 2：英語
CommonTransactionCode	String	請求CODE(全キャンペーン共通)
SeminarTransactionCode	String	請求CODE
CommonVisitorCode	String	リードCODE(全キャンペーン共通)
SeminarVisitorCode	String	リードCODE
LastTransactionId	String	前回申込ID
LastTransactionDate	dateTime	前回申込日付
CreditDate	dateTime	取引日付
ReceiptNo	String	コンビニ受付番号
PaymentFormUrl	String	払い込み票URL
ProxyFlag	String	代理フラグ
PaymentMemo	String	支払メモ
CartList	CartListType	カート一覧 Cart SsDataId：NumberOfApplication キャンペーンID (またはサブキャンペーンID)：申込数 ※キャンペーンIDかサブキャンペーンIDかはApplicationFlowIdにて関連するキャンペーンタイプで判別されます。
PaymentResult	PaymentResultType	取引結果 PaymentResultId：PaymentResultName 1：○ 2：×
PaymentError	String	取引エラー内容
CreditStatus	CreditStatusType	クレジット決済ステータス CreditStatusId：CreditStatusName 1：与信 2：決済
PaymentOrderId	String	取引ID
PaymentAccessId	String	取引アクセスID
PaymentAccessPassword	String	取引アクセスパスワード
PaymentMemo2	String	支払メモ
PaymentMemo3	String	支払メモ
PaymentMemo4	String	支払メモ
PaymentMemo5	String	支払メモ
PaymentMemo6	String	支払メモ
PaymentMemo7	String	支払メモ
PaymentMemo8	String	支払メモ
PaymentMemo9	String	支払メモ
PaymentMemo10	String	支払メモ

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<TransactionList xmlns="http://smartseminar.jp/" version="1.9">
　<Transaction>
　<PaymentAccessId>87f5bc6a833729e5ef41f86433d1b39f</PaymentAccessId>
　<PaymentMemo2>支払いメモ2</PaymentMemo2>
　<ApplicationFlow>
　　<ApplicationFlowId>102</ApplicationFlowId>
　　<ApplicationFlowName>セミナ－申込([ユーザー情報]→[支払方法])</ApplicationFlowName>
　</ApplicationFlow>
　<PaymentMemo5/>
　<CreditStatus>
　　<CreditStatusId>2</CreditStatusId>
　　<CreditStatusName>決済</CreditStatusName>
　</CreditStatus>
　<PaymentError>エラー内容</PaymentError>
　<DateRegist>2011-04-11T20:54:26+09:00</DateRegist>
　<PaymentAccessPassword>0d0e4f21e5b003ccf6155acb273c4827</PaymentAccessPassword>
　<PaymentResult>
　　<PaymentResultName>○</PaymentResultName>
　　<PaymentResultId>1</PaymentResultId>
　</PaymentResult>
　<DiscountPrice>21000</DiscountPrice>
　<VisitorId>1107</VisitorId>
　<PaymentMemo7/>
　<PaymentType>
　　<PaymentTypeName>クレジットカード決済</PaymentTypeName>
　　<PaymentTypeId>1</PaymentTypeId>
　</PaymentType>
　<PaymentMemo6/>
　<ProxyFlag>0</ProxyFlag>
　<Id>558</Id>
　<Language>
　　<LanguageName>日本語</LanguageName>
　　<LanguageId>1</LanguageId>
　</Language>
　<Price>21000</Price>
　<PaymentMemo8/>
　<PaymentFlag>
　　<PaymentFlagName>入金フラグ8</PaymentFlagName>
　　<PaymentFlagId>8</PaymentFlagId>
　</PaymentFlag>
　<PaymentMemo9/>
　<CommonTransactionCode>00302</CommonTransactionCode>
　<PaymentMemo3/>
　<PaymentMemo4/>
　<DateUpdate>2011-04-12T12:00:25+09:00</DateUpdate>
　<PaymentMemo>支払いメモ</PaymentMemo>
　<CartList>
　　<Cart>
　　　<SsDataId>24</SsDataId>
　　　<NumberOfApplication>1</NumberOfApplication>
　　</Cart>
　</CartList>
　<PaymentMemo10/>
　<PaymentOrderId>SS-20110411205428-197982232</PaymentOrderId>
　<CommonVisitorCode>01055</CommonVisitorCode>
　</Transaction>
</TransactionList>

制限事項

なし