リード情報取得API

マーケティングプラットフォームのリード情報を参照するためのAPIです。リード情報には、マーケティングプラットフォームでデフォルト設定されている基本項目と、マーケティングプラットフォームの管理画面から追加可能な追加項目が含まれます。

メソッド名

visitor.get

リクエスト情報

アクセスURL

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

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	オプション	レコードのオフセット
search_condition_id	オプション	検索条件 ID マーケティングプラットフォームに登録済の検索条件IDを指定してください。検索条件IDは、検索条件取得API （ searchcondition.get ) により取得できます。
count	オプション	件数表示「1」を指定すると、レスポンスXMLに取得件数（ count ）と最大件数（ countAll ）が返ります。リクエスト例： /services/rest/visitor?Xxxx&count=1 レスポンス例： <VisitorDataList version="xxx" count="1000" countAll="34045"> <VisitorData> … </VisitorData> </VisitorDataList>

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

カラム名	検索条件	並び順	内容
Id	○	○	リードID
DateRegist	○	○	システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
Name1	○	○	姓
Name2	○	○	名
Name3	○	○	ミドルネーム
Name1Ka	○	○	姓フリガナ
Name2Ka	○	○	名フリガナ
CompanyName	○	○	会社名
CompanyNameKa	○	○	会社名フリガナ
Division	○	○	部署
Position	○	○	役職
Zip1	○	○	郵便番号1
Zip2	○	○	郵便番号2
Zip3	○	○	郵便番号3
CountryId	○	×	国名
PrefectureId	○	×	県
Address1	○	○	住所1
Address2	○	○	住所2
Address3	○	○	住所3
Address4	○	○	住所4
Address5	○	○	住所5
Tel	○	○	電話番号
SubTel	○	○	電話番号予備
Fax	○	○	ファックス番号
Email	○	○	E-Mail アドレス
EmailValid	○	○	E-mailアドレスの有効フラグ 0 : 無効 1 : 有効
EmailSendErrorCount	○	○	E-mailアドレスの連続不達回数
SubEmail	○	○	E-mailアドレス予備
SubEmailValid	○	○	E-mailアドレス予備の有効フラグ 0 : 無効 1 : 有効
SubEmailSendErrorCount	○	○	E-mailアドレス予備の連続不達回数
PermissionTypeId	○	×	最新情報等をメールで受け取りますか
LanguageId	○	×	使用言語 1: 日本語 2: 英語
Memo	○	○	メモ
Attribute{aid}	○	○ （数値型、日付型、日時型）	追加項目追加項目について/追加項目のデータ型参照
Membership	○	×	ログインIDの使用 1:使用する 0:使用しない

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：VisitorData ★ データ型：VisitorDataType

カラム名	データ型	内容
Id	string	リードID
DateRegist	dateTime	システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
LoginId	string	ログインID
LoginPassword	string	ログインパスワード ※マーケティングプラットフォームでシステム設定「パスワードを暗号化して保存」が「有効」の場合、出力されません。
Name1	string	姓
Name2	string	名
Name3	string	ミドルネーム
Name1Ka	string	姓フリガナ
Name2Ka	string	名フリガナ
CompanyName	string	会社名
CompanyNameKa	string	会社名フリガナ
Division	string	部署
Position	string	役職
Zip1	string	郵便番号1
Zip2	string	郵便番号2
Zip3	string	郵便番号3
Country	CountryType	国名 CountryId : CountryName
Prefecture	PrefectureType	都道府県IDと都道府県名の対応表参照
Address1	string	住所1
Address2	string	住所2
Address3	string	住所3
Address4	string	住所4
Address5	string	住所5
Tel	string	電話番号
SubTel	string	電話番号予備
Fax	string	ファックス番号
Email	string	E-Mail アドレス
EmailValid	EmailValidType	E-mailアドレスの有効フラグ EmailValidId : EmailValidName 0 : 無効 1 : 有効
EmailSendErrorCount	nonNegativeInteger	E-mailアドレスの連続不達回数
EmailValidDateUpdate	dateTime	E-mailアドレスの無効日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
SubEmail	string	E-mailアドレス予備
SubEmailValid	SubEmailValidType	E-mailアドレス予備の有効フラグ SubEmailValidId : SubEmailValidName 0 : 無効 1 : 有効
SubEmailSendErrorCount	nonNegativeInteger	E-mailアドレス予備の連続不達回数
SubEmailValidDateUpdate	dateTime	E-mailアドレス予備の無効日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
PermissionType	PermissionTypeType	最新情報等をメールで受け取りますか PermissionTypeId : PermissionTypeName 1 : 希望する 2 : 希望しない
InspectionType	InspectionTypeType	検閲 InspectionTypeId : InspectionTypeName 1: 検閲OK 2: 検閲NG 3: 未検閲
RegistrationType	RegistrationTypeType	登録タイプ RegistrationTypeId : RegistrationTypeName 1:本登録 2:仮登録
Language	LanguageType	使用言語 LanguageId : LanguageName 1: 日本語 2: 英語
Memo	string	メモ
Attribute{aid}	ー	追加項目追加項目について/追加項目のデータ型参照
UserId	string	ユーザID
Membership	MembershipType	ログインIDの使用 MembershipId : MembershipName 1:使用する 0:使用しない
UnsubscribeStatus	string	配信停止
UnsubscribeDate	dateTime	配信停止日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<VisitorDataList xmlns="http://smartseminar.jp/" version="1.5">
　<VisitorData>
　　<Attribute47/>
　　<Memo/>
　　<Attribute8>1111</Attribute8>
　　<Attribute15List>
　　　<Attribute15>
　　　　<Attribute15Id>5</Attribute15Id>
　　　　<Attribute15Name>経営者</Attribute15Name>
　　　</Attribute15>
　　</Attribute15List>
　　<Position>役職１１</Position>
　　<EmailSendErrorCount/>
　　<SubEmailSendErrorCount/>
　　<Address1>千葉市</Address1>
　　<DateUpdate>2009-06-08T15:46:54+09:00</DateUpdate>
　　<CompanyName>会社名１１</CompanyName>
　　<EmailValid>
　　　<EmailValidId>1</EmailValidId>
　　　<EmailValidName>有効</EmailValidName>
　　</EmailValid>
　　<Address2>御徒町</Address2>
　　<Address5/>
　　<CompanyNameKa>カイシャメイフリガナ</CompanyNameKa>
　　<Id>42</Id>
　　<PermissionType>
　　　<PermissionTypeName>希望しない</PermissionTypeName>
　　　<PermissionTypeId>2</PermissionTypeId>
　　</PermissionType>
　　<Tel>1111</Tel>
　　<LoginId>testuser011</LoginId>
　　<Division>部署１１</Division>
　　<SubTel>1111</SubTel>
　　<RegistrationType>
　　　<RegistrationTypeName>本登録</RegistrationTypeName>
　　　<RegistrationTypeId>1</RegistrationTypeId>
　　</RegistrationType>
　　<Attribute17List>
　　　<Attribute17>
　　　　<Attribute17Name>経営管理(可視化)</Attribute17Name>
　　　　<Attribute17Id>5</Attribute17Id>
　　　</Attribute17>
　　　<Attribute17>
　　　　<Attribute17Name>SaaS</Attribute17Name>
　　　　<Attribute17Id>32</Attribute17Id>
　　　</Attribute17>
　　</Attribute17List>
　　<DateRegist>2009-06-06T15:13:57+09:00</DateRegist>
　　<Email>failure011@shanon.co.jp</Email>
　　<InspectionType>
　　　<InspectionTypeName>未検閲</InspectionTypeName>
　　　<InspectionTypeId>3</InspectionTypeId>
　　</InspectionType>
　　<Prefecture>
　　　<PrefectureName>千葉県</PrefectureName>
　　　<PrefectureId>9</PrefectureId>
　　</Prefecture>
　　<SubEmailValid>
　　　<SubEmailValidId>1</SubEmailValidId>
　　　<SubEmailValidName>有効</SubEmailValidName>
　　</SubEmailValid>
　　<Zip1>111</Zip1>
　　<Name1>テスト</Name1>
　　<Address3/>
　　<Name2Ka>ジュウイチロウ</Name2Ka>
　　<Name2>十一郎</Name2>
　　<Zip3/>
　　<SubEmail>failfailure_agency011@shanon.co.jp</SubEmail>
　　<Name3/>
　　<Language>
　　　<LanguageName>日本語</LanguageName>
　　　<LanguageId>1</LanguageId>
　　</Language>
　　<Name1Ka>テスト</Name1Ka>
　　<Zip2>1111</Zip2>
　　<Country>
　　　<CountryName/>
　　　<CountryId/>
　　</Country>
　　<Address4/>
　　<Fax>111</Fax>
　</VisitorData>
</VisitorDataList>

制限事項

なし

注意事項

追加項目数値型を並び順に指定した場合、昇順・降順に関わらず値を持っていないリードは常に最後になります。