リード基本項目設定情報取得API

マーケティングプラットフォームのリード基本項目設定情報を参照するためのAPIです。

メソッド名

visitorsetting.get

リクエスト情報

アクセスURL

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

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=

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

カラム名	検索条件	並び順	内容
VisitorSettingTypeId	○	○	基本項目設定タイプID 1: 基本項目 2: 請求先
LanguageId	○	○	言語ID 1: 日本語 2: 英語
SeminarId	○	○	キャンペーンID 0: 全キャンペーン 0以外: 個別キャンペーンの各キャンペーンID

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：VisitorSetting ★ データ型：VisitorSettingType

カラム名	データ型	内容
VisitorSettingType	VisitorSettingTypeType	基本項目設定タイプ VisitorSettingTypeId：VisitorSettingTypeName 基本項目設定タイプID：基本項目設定タイプ名
Language	LanguageType	言語 LanguageId：LanguageName 言語ID：言語名称
Seminar	SeminarRefType	キャンペーン SeminarId：SeminarName キャンペーンID：キャンペーン名称
VisitorSettingItemList	VisitorSettingItemListType	VisitorSettingItemのリスト基本項目設定情報が格納される
DateRegist	DateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	DateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

★ エレメント名：VisitorSettingItem ★ データ型：VisitorSettingItemType

カラム名	データ型	内容
Name	string	項目システム名称
Description	string	項目名
FormType	FormTypeRefType	フォーム種別 FormTypeId：FormTypeName フォーム種別ID：フォーム種別名称 1:テキスト 2:テキストエリア 3:ラジオボタン 4:チェックボックス 5:プルダウンメニュー 6:パスワード 8:画像 9:ファイル 10:数値 ※FormTypeId:7は利用できません
ErrorType	ErrorTypeRefType	エラー種別 ErrorTypeId：ErrorTypeName エラー種別ID：エラー種別名称 1:全角のみ 2:半角数字のみ 3:E-mailアドレスのみ 4:URL形式のみ 5:電話番号形式のみ 6:全角カタカナのみ 7:半角英数字のみ 8:パスワード形式のみ
IsRequired	int	必須 0:必須にしない 1:必須にする
IsAdminOnly	int	表示/非表示 0:表示 1:管理者側のみ表示
IsEditable	int	パラメータ連携時編集許可 0:編集不可 1:編集可
CommentOnForm	string	フォームの上に表示するコメント
CommentUnderForm	string	フォームの下に表示するコメント
CommentLeftForm	string	フォームの左に表示するコメント
CommentRightForm	string	フォームの右に表示するコメント
Memo	string	メモ
Size	int	フィールドサイズ
MaxSize	int	最大文字数システム設定一覧の「日本語テキストフィールドの最大文字数」の設定（バイト数カウント or 文字数カウント）によって数値の意味が変わります。
TableRows	int	縦幅フォーム種別がテキストエリアの時のみ有効な値
TableCols	int	横幅フォーム種別がテキストエリアの時のみ有効な値
Columns	int	選択肢の並べ方フォーム種別がラジオボタン、チェックボックスの時のみ有効な値
SortOrder	int	項目表示順
DateRegist	DateTime	(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	DateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DefaultList	DefaultListType	デフォルト値 Default : デフォルト設定値
FileSizeMB	int	ファイルサイズ (MB) フォーム種別が画像、ファイルの時のみ有効な値
FileExtensionLimit	FileExtensionLimitType	拡張子の制限フォーム種別が画像、ファイルの時のみ有効な値
ItemList	ItemListType	ItemId : ItemName 選択肢：選択肢名 Icon:アイコン情報 IconName：IconBody 画像名：画像情報(Base64) フォーム種別がラジオボタン、プルダウンメニュー、チェックボックスの時のみ有効な値
IsOnlyInteger	int	値の制限（整数のみ） 0: なし 1: ありフォーム種別が数値の時のみ有効な値
DoubleRange	DoubleRangeType	値の範囲フォーム種別が数値の時のみ有効な値
DatetimeDefaultOption	string	日付型・日時型デフォルト値のオプション 1: なし 2: 登録時の日付・日時 3: 固定の日付･日時フォーム種別が日付･日時の時のみ有効な値

★ エレメント名：FileExtensionLimit ★ データ型：FileExtensionLimitType

カラム名	データ型	内容
FileExtensionItemList	FileExtensionItemListType	FileExtensionItemValue:FileExtensionItemName 拡張子種別：拡張子名
PlusText	string	その他のテキスト

★ エレメント名：DoubleRange ★ データ型：DoubleRangeType

カラム名	データ型	内容
DoubleRangeItemList	DoubleRangeItemListType	Value: 設定値 MagnitudeRelation : 大小関係 MagnitudeRelationName:MagnitudeRelationOperator 大小関係名：大小関係オペレータ

XMLサンプル

リクエストXMLサンプル

★成功例

<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://smartseminar.jp/">
　<SearchValue1>10</SearchValue1>
　<SearchOperator1>eq</SearchOperator1>
　<SearchKey1>SeminarId</SearchKey1>
　<SearchValue1>11</SearchValue1>
　<SearchOperator1>eq</SearchOperator1>
　<SearchKey1>SeminarId</SearchKey1>
　<SearchValue1>12</SearchValue1>
　<SearchOperator1>eq</SearchOperator1>
　<SearchKey1>SeminarId</SearchKey1>
</Request>

★失敗例

<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://smartseminar.jp/">
　<SearchValue1>10</SearchValue1>
　<SearchOperator1>ge</SearchOperator1>
　<SearchKey1>SeminarId</SearchKey1>
　<SearchValue2>12</SearchValue2>
　<SearchOperator2>le</SearchOperator2>
　<SearchKey2>SeminarId</SearchKey2>
</Request>

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<VisitorSettingList xmlns="http://smartseminar.jp/">
　<VisitorSetting>
　　<Id>1</Id>
　　<VisitorSettingType>
　　　<VisitorSettingTypeId>1</VisitorSettingTypeId>
　　　<VisitorSettingTypeName>基本項目</VisitorSettingTypeName>
　　</VisitorSettingType>
　　<Language>
　　　<LanguageId>1</LanguageId>
　　　<LanguageName>日本語</LanguageName>
　　</Language>
　　<Seminar>
　　　<SeminarId>1</SeminarId>
　　　<SeminarName>キャンペーン１</SeminarName>
　　</Seminar>
　　<DateRegist>2010-11-18T21:58:59+09:00</DateRegist>
　　<DateUpdate>2010-11-18T21:58:59+09:00</DateUpdate>
　　<VisitorSettingItemList>
　　　<VisitorSettingItem>
　　　　<Name>name2</Name>
　　　　<Description>名前:名</Description>
　　　　<FormType>
　　　　　<FormTypeId>1</FormTypeId>
　　　　　<FormTypeName>テキスト</FormTypeName>
　　　　</FormType>
　　　　<ErrorType>
　　　　　<ErrorTypeId>6</ErrorTypeId>
　　　　　<ErrorTypeName>全角カタカナのみ</ErrorTypeName>
　　　　</ErrorType>
　　　　<IsRequired>1</IsRequired>
　　　　<isAdminOnly>1</isAdminOnly>
　　　　<IsEditable>0</IsEditable>
　　　　<CommentOnForm>コメント上</CommentOnForm>
　　　　<CommentUnderForm>コメント下</CommentUnderForm>
　　　　<CommentLeftForm>コメント左</CommentLeftForm>
　　　　<CommentRightForm>コメント右</CommentRightForm>
　　　　<Memo>メモ</Memo>
　　　　<Size>15</Size>
　　　　<MaxSize>20</MaxSize>
　　　　<TableRows></TableRows>
　　　　<TableCols></TableCols>
　　　　<Columns></Columns>
　　　　<SortOrder>2</SortOrder>
　　　　<FileSizeMB />
　　　　<AltTextSize />
　　　　<FileExtensionLimit>
　　　　　<FileExtensionItem />
　　　　　<PlusText />
　　　　</FileExtensionLimit>
　　　　<DefaultList>
　　　　　<Default>太郎</Default>
　　　　</DefaultList>
　　　　<DoubleRange>
　　　　　<DoubleRangeItemList />
　　　　</DoubleRange>
　　　　<DatetimeDefaultOption />
　　　　<IsIntegerOnly />　　
　　　</VisitorSettingItem>
　　　<VisitorSettingItem>
　　　　<CommentLeftForm />
　　　　<Memo />
　　　　<Size />
　　　　<ItemList />
　　　　<CommentOnForm />
　　　　<CommentUnderForm />
　　　　<IsEditable />
　　　　<FormType>
　　　　　<FormTypeId>10</FormTypeId>
　　　　　<FormTypeName>double</FormTypeName>
　　　　</FormType>
　　　　<TableRows />
　　　　<MaxSize />
　　　　<Columns />
　　　　<Default />
　　　　<ErrorType>
　　　　　<ErrorTypeName />
　　　　　<ErrorTypeId />
　　　　</ErrorType>
　　　　<FileExtensionLimit>
　　　　　<FileExtensionItem />
　　　　　<PlusText />
　　　　</FileExtensionLimit>
　　　　<TableCols />
　　　　<IsAdminOnly>0</IsAdminOnly>
　　　　<CommentRightForm />
　　　　<SortOrder>42</SortOrder>
　　　　<DoubleRange>
　　　　　<DoubleRangeItemList>
　　　　　　<DoubleRangeItem>
　　　　　　　<MagnitudeRelation>
　　　　　　　　<MagnitudeRelationName>以下</MagnitudeRelationName>
　　　　　　　　<MagnitudeRelationOperator>le</MagnitudeRelationOperator>
　　　　　　　</MagnitudeRelation>
　　　　　　　<Value>100</Value>
　　　　　　</DoubleRangeItem>
　　　　　　<DoubleRangeItem>
　　　　　　　<MagnitudeRelation>
　　　　　　　　<MagnitudeRelationName>以上</MagnitudeRelationName>
　　　　　　　　<MagnitudeRelationOperator>ge</MagnitudeRelationOperator>
　　　　　　　</MagnitudeRelation>
　　　　　　　<Value>0</Value>
　　　　　　</DoubleRangeItem>
　　　　　</DoubleRangeItemList>
　　　　</DoubleRange>
　　　　<DatetimeDefaultOption />
　　　　<FileSizeMB />
　　　　<AltTextSize />
　　　　<IsIntegerOnly />
　　　　<Name>attribute12</Name>
　　　　<Description>数値型項目</Description>
　　　　<IsRequired>0</IsRequired>
　　　</VisitorSettingItem>
　　</VisitorSettingItemList>
　</VisitorSetting>
</VisitorSettingList>

制限事項

リード基本項目設定情報取得APIでは、limit/offset による件数制御および order/direction による並び順の制御が正しく動作しません。そのため、リクエスト時には必ず検索条件に SeminarId を指定することで、取得件数の制限と意図した対象データの取得ができるようにしてください。
検索条件にSeminarId を指定した場合、範囲指定が正しく動作しない場合があるため、SeminarId の値は具体的に指定してください。