マーケティングプラットフォームのリードのファイル情報を参照するためのAPIです。
visitor.getFile
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/visitor/file |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| 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 |
| VisitorFileType | ○ | ○ | リードファイルタイプ VisitorFileTypeId：VisitorFileTypeName 1: 名刺画像表 2: 名刺画像裏 |
| Name | ○ | ○ | リードファイル名 |
| DateRegist | ○ | ○ | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | ○ | ○ | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名：VisitorFile ★ データ型：VisitorFileType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | string | リードファイルID |
| VisitorId | string | リードID |
| VisitorFileType | VisitorFileTypeType | リードファイルタイプ VisitorFileTypeId：VisitorFileTypeName 1: 名刺画像表 2: 名刺画像 |
| Name | string | ファイル名 |
| Body | Base64Binary | データ（Base64エンコード） |
| DateRegist | dateTime | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | dateTime | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
なし
<?xml version="1.0" encoding="UTF-8"?>
<VisitorFileList version="1.5">
<VisitorFile>
<Id>2</Id>
<DateRegist>2010-12-22T13:10:04+09:00</DateRegist>
<DateUpdate>2010-12-22T13:10:59+09:00</DateUpdate>
<VisitorFileType>
<VisitorFileTypeName>名刺画像裏</VisitorFileTypeName>
<VisitorFileTypeId>2</VisitorFileTypeId>
</VisitorFileType>
<Name>googlewave.png</Name>
<Body>/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBhQSEBUUEhQVEBQUF
RUUFhQVFRQUFBQUFBUVFRQVFRQYHCYeFxkjGR
（途中略）
5qcNn4/mrs2RZXDXKbgjB8lbcFE1vALashMQgCVCFQIQhAJEIQFkqEIEKAEq
EAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEH//2Q==</Body>
<VisitorId>1565</VisitorId>
</VisitorFile>
</VisitorFileList>