キャンペーン設定情報取得API

SMPのキャンペーン設定情報を参照するためのAPIです。

メソッド名

seminarsettingdata.get

リクエスト情報

アクセスURL

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

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
Value	○	○	キャンペーン設定情報値
SeminarSettingId	○	○	キャンペーン設定マスタID
SeminarSettingName	○	○	キャンペーン設定名
SeminarId	○	○	キャンペーンID
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

キャンペーン設定情報値の項目補足説明

キャンペーン設定マスタID	キャンペーン設定項目名	フォームタイプ	内容
6	キャンペーン申込時の申込済みチェック/ サブキャンペーン申込時の同一時間帯チェック	ラジオボタン	1：ON 0：OFF
16	マイページからのキャンセル	ラジオボタン	1：ON 0：OFF
17	マイページからの講演資料のダウンロード	ラジオボタン	1：ON 0：OFF
18	マイページからの受講票の使用	ラジオボタン	1：ON 0：OFF
19	マイページからのキャンセル開始日	カレンダー	マイページの申込一覧のテーブルで申込みをキャンセルする開始日を設定します。サンプル：2010-01-01
20	マイページからのキャンセル終了日	カレンダー	マイページの申込一覧のテーブルで申込みをキャンセルする終了日を設定します。サンプル：2010-01-01
21	マイページからの請求書の使用	ラジオボタン	1：ON 0：OFF
23	受講票バーコードID設定	ラジオボタン	1：ユーザーID 2：リードCODE（全キャンペーン） 3：リードCODE（個別キャンペーン） 4：リードID
24	来場時送信用Emailアドレス設定	リストボックス	リード情報を参照
25	来場時Email送信対象（会場来場）	チェックボックス	1：「ON」をチェックする 0：「ON」をチェックしない
26	来場時Email送信対象（サブキャンペーン来場）	チェックボックス	{session_master_id}
27	来場時Email送信実施可能画面	チェックボックス	1：バーコード 2：管理側(CSVアップロード含む) 3：API
28	マイページへの表示	ラジオボタン	1：ON 0：OFF
29	申込時のダブルオプトイン機能	ラジオボタン	1：ON 0：OFF
30	Basic認証の使用	チェックボックス	s_{seminar_master_id}：キャンペーン全体 f_{application_flow_id}：割り当てフロー
31	受講票のバーコード桁数	テキスト	受講票に表示するバーコードの桁を設定します。
32	受講票のバーコード種類	ラジオボタン	7：NW7 8：QRコード 11：Code39
33	受講票のバーコード下の文字表示	ラジオボタン	1：ON 0：OFF
34	利用受講票数	ラジオボタン	1：1種類 2：2種類 3：3種類 4：4種類 5：5種類 6：6種類 7：7種類 8：8種類 9：9種類 10：10種類
35	会場IDのチェックデジット設定	テキスト	来場メニューで使用する会場IDのチェックデジット
36	会場IDの桁数	テキスト	来場メニューで使用する会場IDの桁数
37	サブキャンペーン受付の依存関係の設定	-	サポート対象外
38	リードログインIDの使用	ラジオボタン	1：使用する 0：使用しない
39	リード情報登録時重複チェック範囲	ラジオボタン	1：リードログインIDの使用者のみ 0：しない
40	来場時に更新するリード情報追加項目の設定	チェックボックス	リード基本項目と追加項目を参照
41	QRコードの出力テンプレート	テキストエリア	QRコードの出力内容で任意のテキストを選択した場合QRコードの出力テンプレートを利用することができます。 ※差込項目として、メールテンプレートにて使用できます。
42	QRコードの出力内容	ラジオボタン	1：受講票バーコードID 2：任意のテキスト

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：SeminarSettingDataList ★ データ型：SeminarSettingDataType

カラム名	データ型	内容
Id	string	キャンペーン設定情報ID
Value	string	キャンペーン設定情報値
SeminarSetting	SeminarSettingType	キャンペーン設定マスタ SeminarSettingId：SeminarSettingName キャンペーン設定マスタID：キャンペーン設定名
Seminar	SeminarRefType	キャンペーン SeminarId：SeminarName キャンペーンID：キャンペーン名
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<SeminarSettingDataList xmlns="http://smartseminar.jp/" version="1.44">
    <SeminarSettingData>
        <Seminar>
            <SeminarId>12</SeminarId>
            <SeminarName>てすと中国語（簡体）キャンペーン&lt;zh-cn&gt;测试中文（简体）运动&lt;/zh-cn&gt;</SeminarName>
        </Seminar>
        <Value>4</Value>
        <Id>305</Id>
        <DateUpdate>2016-09-01T17:49:42+08:00</DateUpdate>
        <DateRegist>2016-08-03T16:05:47+08:00</DateRegist>
        <SeminarSetting>
            <SeminarSettingId>23</SeminarSettingId>
            <SeminarSettingName>受講票バーコードID設定</SeminarSettingName>
        </SeminarSetting>
    </SeminarSettingData>
</SeminarSettingDataList>

制限事項

「サブキャンペーン受付の依存関係の設定」は取得できません。