請求先情報取得API

SMPの請求先情報を参照するためのAPIです。

メソッド名

visitor.getBilling

リクエスト情報

アクセスURL

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

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
VisitorId	○	×	リードID
Name1	○	○	姓
Name2	○	○	名
Name3	○	○	請求先ミドルネーム
Name1Ka	○	○	姓フリガナ
Name2Ka	○	○	名フリガナ
CompanyName	○	○	会社名
CompanyNameKa	○	○	会社名フリガナ
Division	○	○	部署
Position	○	○	役職
Zip1	○	○	郵便番号1
Zip2	○	○	郵便番号2
Zip3	○	○	郵便番号3
Country	○	○	国名
Prefecture	○	○	県
Address1	○	○	住所1
Address2	○	○	住所2
Address3	○	○	住所3
Address4	○	○	住所4
Address5	○	○	住所5
Tel	○	○	電話番号
SubTel	○	○	電話番号予備
Fax	○	○	ファックス番号
Email	○	○	E-mailアドレス
SubEmail	○	○	E-mailアドレス予備
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Billing ★ データ型：BillingType

カラム名	データ型	内容
Id	string	請求先ID
VisitorId	string	リードID
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アドレス
SubEmail	string	E-mailアドレス予備

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<BillingList xmlns="http://smartseminar.jp/" version="1.5">
　<Billing>
　　<Id>1</Id>
　　<VisitorId></VisitorId>
　　<Name1>テスト</Name1>
　　<Name2>太郎</Name2>
　　<Name3>J</Name3>
　　<Name1Ka>テスト</Name1Ka>
　　<Name2Ka>タロウ</Name2Ka>
　　<CompanyName>会社名１</CompanyName>
　　<CompanyNameKa>カイシャメイフリガナ１</CompanyNameKa>
　　<Division>部署１</Division>
　　<Position>役職１</Position>
　　<Zip1>111</Zip1>
　　<Zip2>1111</Zip2>
　　<Zip3>11</Zip3>
　　<Country>
　　　<CountryId>1</CountryId>
　　　<CountryName>Japan</CountryName>
　　</Country>
　　<Prefecture>
　　　<PrefectureId>1</PrefectureId>
　　　<PrefectureName>北海道</PrefectureName>
　　</Prefecture>
　　<Address1>札幌市</Address1>
　　<Address2>中央区</Address2>
　　<Address3>双子山</Address3>
　　<Address4>１－１－１</Address4>
　　<Address5>ハイツ○○ ×××号室</Address5>
　　<Tel>111-111-1111</Tel>
　　<SubTel>222-222-2222</SubTel>
　　<Fax>333-333-3333</Fax>
　　<Email>failure01@shanon.co.jp</Email>
　　<SubEmail>failure02@shanon.co.jp</SubEmail>
　</Billing>
</BillingList>

制限事項

なし