申込フロー情報取得API

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

メソッド名

seminar.getFlow

リクエスト情報

アクセスURL

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

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
ApplicationFlowCategoryId	○	○	フロータイプId 1：共通フロー 2：キャンペーンフローテンプレート 3：サブキャンペーンフローテンプレート 4：フロー
SeminarId	○	○	キャンペーンID
BaseFlag	○	○	このフローをデフォルトとする 0：しない 1：する
ThrowCart	○	○	カート（選択内容確認）画面 0：使用する 1：使用しない
ThrowUser	○	○	ログイン状態での申込時の基本項目+アンケート入力画面 0：入力させる 1：入力させない(画面スキップ) 2：エラー発生時は入力させる
UseMultiApplication	○	○	キャンペーン/サブキャンペーン複数人申込 0：使用しない 1：使用する
UseDiscount	○	○	キャンペーンコード 0：オプション 1：必須
UseTimetableRestore	○	○	追加申込時のタイムテーブルでの選択内容復元方法 1：キャンペーン申込時申込内容変更、サブキャンペーン申込時アイコン復元 2：サブキャンペーン申込時チェックボックス復元 3：常に新規申込(復元なし)
UsePackageChange	○	○	追加申込時の請求金額の変更許可 1：増加のみ可 2：増減可 3：増減不可
RestoreLoginUser	○	○	ログイン状態での申込 1：可能 2：不可(強制ログアウトしてから申込)
ThrowPaymentAndBillingInFree	○	○	合計ゼロ円の場合の支払方法/請求先 0：入力させる 1：入力させない(画面スキップ)
Memo	○	○	メモ
FlowComment	○	○	コメント(リードへの説明)

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★エレメント名：ApplicationFlow ★データ型：ApplicationFlowType

カラム名	データ型	内容
Name	string	名前
FlowComment	string	コメント（リードへの説明）
Id	string	申込フローID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
ApplicationFlowCategory	ApplicationFlowCategoryType	フロータイプ ApplicationFlowCategoryId：ApplicationFlowCategoryName 1：共通フロー 2：キャンペーンフローテンプレート 3：サブキャンペーンフローテンプレート 4：フロー 5：キャンペーン埋め込みフォームテンプレート 6：埋め込みフォーム
Seminar	SeminarRefType	フローに所属するキャンペーン名 SeminarId：SeminarName
Name	string	名前
FlowComment	string	コメント(リードへの説明)
Memo	string	メモ
BaseFlag	nonNegativeInteger	このフローをデフォルトとする 0：しない 1：する
ThrowCart	nonNegativeInteger	カート(選択内容確認)画面 0：使用する 1：使用しない
ThrowUser	nonNegativeInteger	ログイン状態での申込時の基本項目+アンケート入力画面 0：入力させる 1：入力させない(画面スキップ) 2：エラー発生時は入力させる
ApplicationLinkMemberFlag	nonNegativeInteger	会員用申込リンク表示 1：使用しない
UseMultiApplication	nonNegativeInteger	キャンペーン/サブキャンペーン複数人申込 0：使用しない 1：使用する
UseDiscount	nonNegativeInteger	キャンペーンコード 0：オプション 1：必須
UseTimetableRestore	nonNegativeInteger	追加申込時のタイムテーブルでの選択内容復元方法 1：アイコン復元 2：チェックボックス復元 3：復元なし
UsePackageChange	nonNegativeInteger	追加申込時の請求金額の変更許可 1：増加のみ可 2：増減可 3：増減不可
RestoreLoginUser	nonNegativeInteger	ログイン状態での申込 1：可能 2：不可(強制ログアウトしてから申込)
ThrowPaymentAndBillingInFree	nonNegativeInteger	合計ゼロ円の場合の支払方法/請求先 0：入力させる 1：入力させない(画面スキップ)
ApplicationStepList	ApplicationStepListType	フローに所属するステップ一覧 ApplicationStep ApplicationStepId：ApplicationStepName
RecaptchaSiteKey	string	埋め込みフォーム機能でのみ使用される値 reCAPTCHAのサイトキー
SubmitAfterTypeMasterId	nonNegativeInteger	埋め込みフォーム機能でのみ使用される値申込登録完了時の挙動 1：指定の完了メッセージを表示 2：指定のURLへリダイレクト
SubmitAfterOutputMessage	string	埋め込みフォーム機能でのみ使用される値申込登録完了時に出力されるメッセージ
SubmitAfterRedirectUrl	string	埋め込みフォーム機能でのみ使用される値リダイレクト先URL
EmbeddedFormCode	string	埋め込みフォーム機能でのみ使用される値埋め込みフォームコード
TemplateFlag	nonNegativeInteger	申込フローのテンプレートを判別する 0：申込フロー種別が「フロー」と「埋め込みフォーム」 1：申込フロー種別が「フロー」と「埋め込みフォーム」以外

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<ApplicationFlowList xmlns="http://smartseminar.jp/" version="1.5">
　<ApplicationFlow>
　　<Id>1</Id>
　　<DateRegist>2009-03-06T15:50:34+09:00</DateRegist>
　　<DateUpdate>2009-03-06T15:50:34+09:00</DateUpdate>
　　<ApplicationFlowCategory>
　　　<ApplicationFlowCategoryId>1</ApplicationFlowCategoryId>
　　　<ApplicationFlowCategoryName>キャンペーンフローテンプレー</ApplicationFlowCategoryName>
　　</ApplicationFlowCategory>
　　<Seminar>
　　　<SeminarId>1</SeminarId>
　　　<SeminarName>キャンペーンタイトル</SeminarName>
　　</Seminar>
　　<Name>申込フロータイトル</Name>
　　<FlowComment>フローコメント</FlowComment>
　　<Memo>メモ</Memo>
　　<BaseFlag>0</BaseFlag>
　　<ThrowCart>0</ThrowCart>
　　<ThrowUser>0</ThrowUser>
　　<ApplicationLinkMemberFlag>1</ApplicationLinkMemberFlag>
　　<UseMultiApplication>0</UseMultiApplication>
　　<UseDiscount>0</UseDiscount>
　　<UseTimetableRestore>2</UseTimetableRestore>
　　<UsePackageChange>2</UsePackageChange>
　　<RestoreLoginUser>0</RestoreLoginUser>
　　<ThrowPaymentAndBillingInFree>1</ThrowPaymentAndBillingInFree>
　　<ApplicationStepList>
　　　<ApplicationStep>
　　　　<ApplicationStepId>1</ApplicationStepId>
　　　　<ApplicationStepName>ユーザー情報登録</ApplicationStepName>
　　　</ApplicationStep>
　　<ApplicationStep>
　　　<ApplicationStepId>7</ApplicationStepId>
　　　<ApplicationStepName>完了</ApplicationStepName>
　　</ApplicationStep>
　</ApplicationStepList>
　</ApplicationFlow>
</ApplicationFlowList>

制限事項

なし