マーケティングプラットフォームの一括登録の結果を参照するためのAPIです。
bulkapi.get
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/bulkapi |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| Id | オプション | 結果ID |
| 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 |
| DateRegist | ○ | ○ | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | ○ | ○ | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| StartDate | ○ | ○ | 処理開始日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| EndDate | ○ | ○ | 処理終了日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| BulkStatus | ○ | ○ | ステータス BulkStatusId : BulkStatusName 1：未実行 2：実行中 3：終了 4：異常終了 |
| Method | ○ | ○ | 登録対象のAPIメソッド名 |
| TotalRecordNum | ○ | ○ | 処理対象のデータ数 |
| SuccessRecordNum | ○ | ○ | 処理結果が成功のデータ数 |
| ErrorRecordNum | ○ | ○ | 処理結果がエラーのデータ数 |
| UnexecutedRecordNum | ○ | ○ | 処理が実行されなかったデータ数 |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名：Bulk ★ データ型：BulkType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | nonNegativeInteger | 結果ID |
| DateRegist | dateTime | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | dateTime | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| StartDate | dateTime | 処理開始日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| EndDate | dateTime | 処理終了日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| Method | string | 登録対象のAPIメソッド名 |
| ParameterList | ParameterListType | 登録時に指定したURLパラメータ Key：URLパラメータキー Value：URLパラメータ値 |
| BulkStatus | BulkStatusType | ステータス 1：未実行 2：実行中 3：終了 4：異常終了 |
| TotalRecordNum | nonNegativeInteger | 処理対象のデータ数 |
| SuccessRecordNum | nonNegativeInteger | 処理結果が成功のデータ数 |
| ErrorRecordNum | nonNegativeInteger | 処理結果がエラーのデータ数 |
| UnexecutedRecordNum | nonNegativeInteger | 処理が実行されなかったデータ数 |
| BulkResultDataList | BulkResultDataListType | 処理結果（BulkStatusが終了, 異常終了の場合のみ出力されます） BulkResultData：データ1件あたりの処理結果 BulkResultStatus：対象データの処理結果 BulkResultStatusId : BulkResultStatusName 1:成功 2:エラー 3:未実行 Location： 成功の場合、登録されたリソースへのURL Fault： エラー内容（処理結果がエラーの場合のみ出力されます） Reason： エラー内容 Text ： エラー内容 RequestData ： 処理対象のデータ RequestDataに含まれるデータ型はMethodに応じて変わります。 詳しくは、bulkapi.postの「指定可能なAPI」を参照してください。 ※BulkResultDataListは、ステータスが「終了」「異常終了」の一括登録実行結果を、URLパラメータ部にIdを指定してした場合にレスポンスに含まれます。 ※リスト系は部分的にエラーが発生する確率が低いため、この項目は出力されません |
なし
visitor.postの場合の例です：
<?xml version="1.0" encoding="UTF-8"?>
<BulkList xmlns="http://smartseminar.jp/" version="1.21">
<Bulk>
<Method>visitor.post</Method>
<Id>4</Id>
<BulkStatus>
<BulkStatusName>終了</BulkStatusName>
<BulkStatusId>1</BulkStatusId>
</BulkStatus>
<TotalRecordNum>2</TotalRecordNum>
<SuccessRecordNum>1</SuccessRecordNum>
<ErrorRecordNum>1</ErrorRecordNum>
<UnexecutedRecordNum>1</UnexecutedRecordNum>
<ParameterList>
<Parameter>
<Value>1</Value>
<Key>upsert</Key>
</Parameter>
</ParameterList>
<BulkResultDataList>
<BulkResultData>
<BulkResultStatus>
<BulkResultStatusName>エラー</BulkResultStatusName>
<BulkResultStatusId>2</BulkResultStatusId>
</BulkResultStatus>
<Fault>
<Reason>
<Text>ユーザー未登録です</Text>
</Reason>
</Fault>
<RequestData>
<VisitorData>
<Memo/>
<Attribute8>1111</Attribute8>
<Position>役職１１</Position>
<Address1>千葉市</Address1>
<DateUpdate>2009-06-08T15:46:54+09:00</DateUpdate>
<CompanyName>会社名１１</CompanyName>
<EmailValid>
<EmailValidId>1</EmailValidId>
<EmailValidName>有効</EmailValidName>
</EmailValid>
<Address2>御徒町</Address2>
<CompanyNameKa>カイシャメイイチイチ</CompanyNameKa>
<PermissionType>
<PermissionTypeName>希望しない</PermissionTypeName>
<PermissionTypeId>2</PermissionTypeId>
</PermissionType>
<Tel>1111</Tel>
<Division>部署１１</Division>
<SubTel>1111</SubTel>
<RegistrationType>
<RegistrationTypeName>本登録</RegistrationTypeName>
<RegistrationTypeId>1</RegistrationTypeId>
</RegistrationType>
<Attribute17>
<Attribute17Name>SaaS</Attribute17Name>
<Attribute17Id>32</Attribute17Id>
</Attribute17>
<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>failure_agency011@shanon.co.jp</SubEmail>
<Name3/>
<Language>
<LanguageName>日本語</LanguageName>
<LanguageId>1</LanguageId>
</Language>
<Name1Ka>テスト</Name1Ka>
<Zip2>1111</Zip2>
<Fax>111</Fax>
</VisitorData>
</RequestData>
</BulkResultData>
<BulkResultData>
<BulkResultStatus>
<BulkResultStatusId>1</BulkResultStatusId>
<BulkResultStatusName>成功</BulkResultStatusName>
</BulkResultStatus>
<Location>https://{domainname}/services/rest/visitor/123</Location>
<RequestData>
<VisitorData>
<Memo/>
<Attribute8>1122</Attribute8>
<Position>役職２</Position>
<Address1>相模原市</Address1>
<DateUpdate>2009-07-06T14:54:53+09:00</DateUpdate>
<CompanyName>会社名２</CompanyName>
<EmailValid>
<EmailValidId>1</EmailValidId>
<EmailValidName>有効</EmailValidName>
</EmailValid>
<Address2>南区</Address2>
<CompanyNameKa>カイシャメイニ</CompanyNameKa>
<PermissionType>
<PermissionTypeName>希望しない</PermissionTypeName>
<PermissionTypeId>2</PermissionTypeId>
</PermissionType>
<Tel>01-2345-6789</Tel>
<Division>部署２</Division>
<SubTel></SubTel>
<RegistrationType>
<RegistrationTypeName>本登録</RegistrationTypeName>
<RegistrationTypeId>1</RegistrationTypeId>
</RegistrationType>
<Attribute17>
<Attribute17Name>SaaS</Attribute17Name>
<Attribute17Id>32</Attribute17Id>
</Attribute17>
</Attribute17List>
<DateRegist>2009-06-03T13:11:34+09:00</DateRegist>
<Email>test01@shanon.co.jp</Email>
<InspectionType>
<InspectionTypeName>未検閲</InspectionTypeName>
<InspectionTypeId>3</InspectionTypeId>
</InspectionType>
<Prefecture>
<PrefectureName>神奈川県</PrefectureName>
<PrefectureId>8</PrefectureId>
</Prefecture>
<SubEmailValid>
<SubEmailValidId>1</SubEmailValidId>
<SubEmailValidName>有効</SubEmailValidName>
</SubEmailValid>
<Zip1>111</Zip1>
<Name1>山田</Name1>
<Address3/>
<Name2Ka>タロウ</Name2Ka>
<Name2>太朗</Name2>
<Zip3/>
<SubEmail>failure_agency011@shanon.co.jp</SubEmail>
<Name3/>
<Language>
<LanguageName>日本語</LanguageName>
<LanguageId>1</LanguageId>
</Language>
<Name1Ka>ヤマダ</Name1Ka>
<Zip2>1111</Zip2>
<Fax>111</Fax>
</VisitorData>
</RequestData>
</BulkResultData>
</BulkStatus>
</BulkResultDataList>
</Bulk>
</BulkList>
staticlist.postVisitorを実行して成功し、二つのリードを追加した場合の例です：
<?xml version="1.0" encoding="UTF-8"?>
<BulkList xmlns="http://smartseminar.jp/" version="1.54">
<Bulk>
<StartDate>2018-01-09T16:04:37+09:00</StartDate>
<EndDate>2018-01-09T16:04:37+09:00</EndDate>
<Method>staticlist.postVisitor</Method>
<Id>7</Id>
<ParameterList>
<Parameter>
<Key>ignore_itemcheck</Key>
<Value>1</Value>
</Parameter>
<Parameter>
<Key>staticlist_id</Key>
<Value>2</Value>
</Parameter>
</ParameterList>
<TotalRecordNum>2</TotalRecordNum>
<SuccessRecordNum>2</SuccessRecordNum>
<ErrorRecordNum>0</ErrorRecordNum>
<UnexecutedRecordNum>0</UnexecutedRecordNum>
<BulkStatus>
<BulkStatusName>終了</BulkStatusName>
<BulkStatusId>3</BulkStatusId>
</BulkStatus>
<DateUpdate>2018-01-09T16:04:37+09:00</DateUpdate>
<DateRegist>2018-01-09T16:04:36+09:00</DateRegist>
</Bulk>
</BulkList>