マーケティングプラットフォームの企業に属するリード情報を参照するためのAPIです。 リード情報には、リードIDだけが含まれます。それ以外の当該リードに関する情報は、リードのAPIを使って取得してください。
company.getVisitor
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/company/visitor |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| 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 | オプション | レコードのオフセット |
| count | オプション | 件数表示 「1」を指定すると、レスポンスXMLに取得件数（ count ）と最大件数（ countAll ）が返ります。 リクエスト例： /services/rest/company/visitor?Xxxx&count=1 レスポンス例： <CompanyVisitorList version="xxx" count="1000" countAll="34045"> <CompanyVisitor> … </CompanyVisitor> </CompanyVisitorList> |
####検索条件・並び順に指定可能なカラム
| カラム名 | 検索条件 | 並び順 | 内容 |
|---|---|---|---|
| Id | ○ | ○ | 企業とリードの紐付きID |
| DateRegist | ○ | ○ | システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | ○ | ○ | システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| CompanyId | ○ | ○ | 企業ID |
| VisitorId | ○ | ○ | リードID |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名：CompanyVisitor ★ データ型：CompanyVisitorType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | string | 企業とリードの紐付きID |
| DateRegist | dateTime | システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | dateTime | システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| CompanyId | string | 企業ID |
| VisitorId | string | リードID |
なし
下記は1つの企業（ID=1）から二つのリード（それぞれのIDは101、102）を取得した例です：
<?xml version="1.0" encoding="UTF-8"?>
<CompanyVisitorList xmlns="http://smartseminar.jp/" version="1.57">
<CompanyVisitor>
<Id>11</Id>
<DateUpdate>2019-03-23T12:32:11+09:00</DateUpdate>
<DateRegist>2019-03-23T12:32:11+09:00</DateRegist>
<CompanyId>1</CompanyId>
<VisitorId>101</VisitorId>
</CompanyVisitor>
<CompanyVisitor>
<Id>12</Id>
<DateUpdate>2019-03-23T12:32:11+09:00</DateUpdate>
<DateRegist>2019-03-23T12:32:11+09:00</DateRegist>
<CompanyId>1</CompanyId>
<VisitorId>102</VisitorId>
</CompanyVisitor>
</CompanyVisitorList>
なし