マーケティングプラットフォームのキャンペーンに関連する申込情報を参照するためのAPIです。
※キャンペーンの申込種別には「キャンペーン型」と「サブキャンペーン型」があります。サブキャンペーン型の申込履歴を取得する場合、本APIではなく「申込情報取得API」または「サブキャンペーン申込情報取得API」をご利用ください。
visitor.getApplicationSeminar
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/visitor/application/seminar |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| 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 | オプション | レコードのオフセット |
| カラム名 | 検索条件 | 並び順 | 内容 |
|---|---|---|---|
| VisitorId | ○ | × | リードID |
| SeminarId | ○ | ○ | キャンペーンID |
| ApplicationStatus | ○ | ○ | 申込ステータス ApplicationStatusId：ApplicationStatusName 1：申し込み 2：キャンセル |
| ApplicationDate | ○ | ○ | 申込日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| TransactionId | ○ | × | 申込ID |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名：SeminarApplication ★ データ型：SeminarApplicationType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | string | ※この項目はTransactionIdListに置き換えられています。WSDL上でdeprecated属性が付きます。 |
| Seminar | SeminarRefType | キャンペーン SeminarId：SeminarName キャンペーンID：キャンペーン名 |
| VisitorId | string | リードID |
| ApplicationStatus | ApplicationStatusType | 申込ステータスID ApplicationStatusId：ApplicationStatusName 1：申し込み 2：キャンセル ※同一リードIDかつ同一キャンペーンに対してApplicationStatuIdに1と2のレコードが存在する場合があります。これは、変更(過去の申込をキャンセルして申込を行なったこと)を意味します。ただし、複数の変更が行われた場合は、最新の情報のみ返します。 |
| NumberOfApplication | nonNegativeInteger | 申込数 |
| ApplicationDate | dateTime | 申込日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| TransactionIdList | VisitorTransactionIdListType | 申込ID TransactionId |
なし
<?xml version="1.0" encoding="UTF-8"?>
<SeminarApplicationList xmlns="http://smartseminar.jp/" version="1.31">
<SeminarApplication>
<Seminar>
<SeminarId>1</SeminarId>
<SeminarName>キャンペーン1</SeminarName>
</Seminar>
<ApplicationStatus>
<ApplicationStatusName>申し込み</ApplicationStatusName>
<ApplicationStatusId>1</ApplicationStatusId>
</ApplicationStatus>
<ApplicationDate>2014-03-19T18:12:34+09:00</ApplicationDate>
<TransactionIdList>
<TransactionId>3</TransactionId>
</TransactionIdList>
<NumberOfApplication>1</NumberOfApplication>
<VisitorId>2</VisitorId>
</SeminarApplication>
</SeminarApplicationList>
なし