キャンペーン情報取得API

マーケティングプラットフォームのキャンペーン情報を参照するためのAPIです。

メソッド名

seminar.get

リクエスト情報

アクセスURL

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

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
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時（JST） YYYY-mm-ddTHH:MM:SS+09:00
SsTargetTypeId	○	×	申込種別
PriceTypeId	○	×	課金種別
SeminarCategoryId	○	×	カテゴリ
SeminarStatusId	○	×	状態
PortalPublicationTypeId	○	×	カスタム設定(ポータル公開条件)
SeminarPublicationTypeId	○	×	カスタム設定(キャンペーン詳細公開条件)
FlowPublicationTypeId	○	×	カスタム設定(申込条件)
PreserveSearchConditionId	○	×	カスタム設定(リードの検索条件フィルタ)
Title	○	○	キャンペーンタイトル
SubTitle	○	○	キャンペーンサブタイトル
Summary	○	○	キャンペーン概要
Detail	○	○	キャンペーン詳細
Notes	○	○	注意事項
TargetUser	○	○	対象者
Sponsor	○	○	主催
CoSponsor	○	○	共催
HtmlEditorTypeId	○	○	エディタ種別
NewsBody	○	○	フリー入力欄
Memo	○	○	メモ
StartDay	○	○	開催期間（開始日時）
EndDay	○	○	開催期間（終了日時）
StartDayDisplay	○	○	表示用開催期間（開始日時）
ApplicationStartDay	○	○	申込期間（開始日時）
ApplicationEndDay	○	○	申込期間（終了日時）
ApplicationStartDayDisplay	○	○	表示用申込期間（開始日時）
LimitUserNum	○	○	定員
LimitUserNumDisplay	○	○	表示用定員
Cost	○	○	実施コスト
HallName	○	○	会場名
HallZipcode	○	○	会場の郵便番号
PrefectureId	○	×	会場の住所(都道府県)
HallAddress	○	○	会場の住所
HallTel	○	○	会場の電話番号
HallNote	○	○	会場備考
HallMapUrl	○	○	会場URL
ReferenceName	○	○	お問合せ先名
ReferencePersonInCharge	○	○	お問合せ先担当者
ReferenceEmail	○	○	お問合せ先E-mail
ReferenceTel	○	○	お問合せ先電話番号
ReferenceFax	○	○	お問合せ先ファックス番号
ReferenceAddress	○	○	お問合せ先住所
ReferenceNote	○	○	お問合せ先備考
Attribute{aid}	○	×	追加項目追加項目について/追加項目のデータ型参照

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Seminar ★ データ型：SeminarType

カラム名	データ型	内容
Id	string	キャンペーンID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時（JST） YYYY-mm-ddTHH:MM:SS+09:00
SsTargetType	SsTargetTypeType	キャンペーンタイプID SsTargetTypeId：SsTargetTypeName 1 : キャンペーン 2 : サブキャンペーン
UseSessionFlag	nonNegativeInteger	サブキャンペーン使用フラグ
PriceType	PriceTypeType	課金種別 PriceTypeId：PriceTypeName
SeminarCategory	SeminarCategoryType	カテゴリ SeminarCategoryId：SeminarCategoryName
SeminarStatus	SeminarStatusType	状態 SeminarStatusId：SeminarStatusName
PortalPublicationType	PortalPublicationTypeType	カスタム設定(ポータル公開条件) PortalPublicationTypeId：PortalPublicationTypeName
SeminarPublicationType	SeminarPublicationTypeType	カスタム設定(キャンペーン詳細公開条件) SeminarPublicationTypeId：SeminarPublicationTypeName
FlowPublicationType	FlowPublicationTypeType	カスタム設定(申込条件) FlowPublicationTypeId：FlowPublicationTypeName
PreserveSearchCondition	PreserveSearchConditionType	カスタム設定(リードの検索条件フィルタ) PreserveSearchConditionId：PreserveSearchConditionName
Title	string	キャンペーンタイトル
SubTitle	string	キャンペーンサブタイトル
Summary	string	キャンペーン概要
Detail	string	キャンペーン詳細
Notes	string	注意事項
TargetUser	string	対象者
Sponsor	string	主催
CoSponsor	string	共催
Support	string	協賛
HtmlEditorType	HtmlEditorTypeType	エディタ種別 HtmlEditorTypeId：HtmlEditorTypeName
NewsBody	string	フリー入力欄
Memo	string	メモ
StartDay	dateTime	開催期間（開始日時）
EndDay	dateTime	開催期間（終了日時）
StartDayDisplay	string	表示用開催期間（開始日時）
ApplicationStartDay	dateTime	申込期間（開始日時）
ApplicationEndDay	dateTime	申込期間（終了日時）
ApplicationStartDayDisplay	string	表示用申込期間（開始日時）
LimitUserNum	nonNegativeInteger	定員
LimitUserNumDisplay	string	表示用定員
Cost	int	実施コスト
TargetCostPerPerson	int	目標単価
ApplicationAmount	string	リード数/定員
NumberOfApplicants	nonNegativeInteger	リード数
NumberOfApplications	nonNegativeInteger	申込数
CapacityStatus	string	定員状況 : 残席あり : 満席 : 残席わずか
AcceptanceStatus	string	受付状況 : 申込可 : 申込前 : 申込終了 : 満席
HallName	string	会場名
HallZipcode	string	会場の郵便番号
Prefecture	PrefectureType	会場の住所（都道府県）都道府県IDと都道府県名の対応表参照
HallAddress	string	会場の住所
HallTel	string	会場の電話番号
HallNote	string	会場備考
HallMapUrl	string	会場URL
ReferenceName	string	お問合せ先名
ReferencePersonInCharge	string	お問合せ先担当者
ReferenceEmail	string	お問合せ先E-mail
ReferenceTel	string	お問合せ先電話番号
ReferenceFax	string	お問合せ先ファックス番号
ReferenceAddress	string	お問合せ先住所
ReferenceNote	string	お問合せ先備考
StatusChangedDate	dateTime	ステータス変更日時
Price	nonNegativeInteger	金額
PriceDisplay	string	表示用金額
DetailFile	DetailFileType	詳細画像 DetailFileID：DetailFileName
HallFile	HallFileType	会場地図 HallFileId：HallFileName：HallFilePath：HallFileExtension
HeaderFile	HeaderFileType	ヘッダー画像 HeaderFileId：HeaderFileName：HeaderFileExtension：HeaderFilePath
SpeakerList	SpeakerListRefType	講演者一覧
Attribute{aid}	－	追加項目追加項目について/追加項目のデータ型参照

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<SeminarList xmlns="http://smartseminar.jp/" version="1.5">
　<Seminar>
　　<HallFile>
　　　<HallFilePath>https://192.168.1.172/static/upload/192.168.1.172/file/22/test3.jpg
　　　</HallFilePath>
　　　<HallFileName>test3</HallFileName>
　　　<HallFileId>22</HallFileId>
　　</HallFile>
　　<Attribute1>テストサブキャンペーン</Attribute1>
　　<FlowPublicationType>
　　　<FlowPublicationTypeId>4</FlowPublicationTypeId>
　　　<FlowPublicationTypeName>すべて公開</FlowPublicationTypeName>
　　</FlowPublicationType>
　　<SeminarCategory>
　　　<SeminarCategoryName>てすとカテゴリ</SeminarCategoryName>
　　　<SeminarCategoryId>1</SeminarCategoryId>
　　</SeminarCategory>
　　<DateRegist>2008-11-18T13:13:01+09:00</DateRegist>
　　<ApplicationStartDay>2008-11-18T00:00:00+09:00</ApplicationStartDay>
　　<ApplicationAmount>13/無制限</ApplicationAmount>
　　<NumberOfApplications>20</NumberOfApplications>
　　<PortalPublicationType>
　　　<PortalPublicationTypeId>4</PortalPublicationTypeId>
　　　<PortalPublicationTypeName>すべて公開</PortalPublicationTypeName>
　　</PortalPublicationType>
　　<SpeakerList>
　　　<Speaker>
　　　　<SpeakerId>3</SpeakerId>
　　　　<SpeakerName>講演者　姓３ 講演者　名３</SpeakerName>
　　　</Speaker>
　　</SpeakerList>
　　<CapacityStatus>残席あり</CapacityStatus>
　　<StartDay>2012-11-17T00:00:00+09:00</StartDay>
　　<DateUpdate>2009-06-29T20:18:59+09:00</DateUpdate>
　　<SsTargetType>
　　　<SsTargetTypeName>サブキャンペーン</SsTargetTypeName>
　　　<SsTargetTypeId>2</SsTargetTypeId>
　　</SsTargetType>
　　<NumberOfApplicants>13</NumberOfApplicants>
　　<SeminarPublicationType>
　　　<SeminarPublicationTypeId>4</SeminarPublicationTypeId>
　　　<SeminarPublicationTypeName>すべて公開</SeminarPublicationTypeName>
　　</SeminarPublicationType>
　　<Attribute2List>
　　　<Attribute2>
　　　　<Attribute2Name>１</Attribute2Name>
　　　　<Attribute2Id>1</Attribute2Id>
　　　</Attribute2>
　　</Attribute2List>
　　<Title>テストキャンペーン～サブキャンペーン型その１～髙㈱Ⅰ</Title>
　　<StatusChangedDate>2008-11-18T13:17:00+09:00</StatusChangedDate>
　　<SeminarStatus>
　　　<SeminarStatusId>1</SeminarStatusId>
　　　<SeminarStatusName>公開</SeminarStatusName>
　　</SeminarStatus>
　　<EndDay>2012-11-20T00:00:00+09:00</EndDay>
　　<TargetCostPerPerson>\1,000</TargetCostPerPerson>
　　<Cost>\10,000,000</Cost>
　　<UseSessionFlag>2</UseSessionFlag>
　　<ApplicationEndDay>2012-11-17T00:00:00+09:00</ApplicationEndDay>
　　<VisitorAmount>13</VisitorAmount>
　　<Id>14</Id>
　　<AcceptanceStatus>申込可</AcceptanceStatus>
　　<PriceType>
　　　<PriceTypeName>サブキャンペーン課金</PriceTypeName>
　　　<PriceTypeId>3</PriceTypeId>
　　</PriceType>
    <HtmlEditorType>
       <HtmlEditorTypeId>1</HtmlEditorTypeId>
       <HtmlEditorTypeName>エディタ</HtmlEditorTypeName>
    </HtmlEditorType>
　　<Attribute3List>
　　　<Attribute3>
　　　　<Attribute3Id>1</Attribute3Id>
　　　　<Attribute3Name>１</Attribute3Name>
　　　</Attribute3>
　　</Attribute3List>
　</Seminar>
</SeminarList>

制限事項

-なし