サブキャンペーン情報取得API

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

メソッド名

seminar.getSession

リクエスト情報

アクセスURL

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

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	○	×	キャンペーンタイプID 1: キャンペーン 2: サブキャンペーン
SessionCategoryId	○	×	サブキャンペーンカテゴリID
SeminarId	○	×	サブキャンペーンの属するキャンペーン
Code	○	○	コード
Title	○	○	サブキャンペーンタイトル
SubTitle	○	○	サブキャンペーンサブタイトル
Summary	○	○	サブキャンペーン概要
Detail	○	○	サブキャンペーン詳細
TargetUser	○	○	サブキャンペーン対象者
Notes	○	○	注意事項
TimetableNotes	○	○	注意文（タイムテーブルへの表示用）
HtmlEditorTypeId	○	○	エディタ種別
NewsBody	○	○	来場者側のサブキャンペーン詳細（フリー入力欄）
Memo	○	○	メモ
StartDay	○	○	開催期間（開始日時）
EndDay	○	○	開催期間（終了日時）
StartDayDisplay	○	○	表示用開催期間（開始日時）
ApplicationStartDay	○	○	申込期間（開始日時）
ApplicationEndDay	○	○	申込期間（終了日時）
ApplicationStartDayDisplay	○	○	表示用申込期間（開始日時）
LimitUserNum	○	○	定員
LimitUserNumDisplay	○	○	表示用定員
HallName	○	○	会場名
HallZipcode	○	○	会場の郵便番号
HallAddress	○	○	会場の住所
HallTel	○	○	会場の電話番号
HallNote	○	○	会場備考
HallMapUrl	○	○	会場URL
ReferenceName	○	○	お問合せ先名
ReferencePersonInCharge	○	○	お問合せ先担当者
ReferenceEmail	○	○	お問合せ先E-mail
ReferenceTel	○	○	お問合せ先電話番号
ReferenceFax	○	○	お問合せ先ファックス番号
ReferenceAddress	○	○	お問合せ先住所
ReferenceNote	○	○	お問合せ先備考

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Session ★ データ型：SessionType

カラム名	データ型	内容
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：サブキャンペーン
SessionCategory	SessionCategoryType	カテゴリ SessionCategoryId：SessionCategoryName
Seminar	SeminarRefType	サブキャンペーンに所属するキャンペーン SeminarId：SeminarName
Code	string	コード
Title	string	サブキャンペーンタイトル
SubTitle	string	サブキャンペーンサブタイトル
Summary	string	サブキャンペーン概要
Detail	string	サブキャンペーン詳細
TargetUser	string	サブキャンペーン対象者
Notes	string	注意事項
TimetableNotes	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	表示用定員
HallName	string	会場名
HallZipcode	string	会場の郵便番号
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	お問合せ先備考
Price	nonNegativeInteger	金額
PriceDisplay	string	表示用金額
HallFile	HallFileType	会場地図 HallFileId：HallFileName：HallFilePath：HallFileExtension
PaymentFlag	PaymentFlagType	有料／無料 PaymentFlagId：PaymentFlagName 1：無料 2：有料
SpeakerList	SpeakerListRefType	講演者一覧
Attribute{aid}	－	追加項目追加項目について/追加項目のデータ型参照

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<SessionList xmlns="http://smartseminar.jp/" version="1.5">
　<Session>
　　<HallFile/>
　　<ReferenceEmail/>
　　<Attribute1>テストサブキャンペーン</Attribute1>
　　<ReferenceFax/>
　　<HallTel/>
　　<Memo/>
　　<DateRegist>2009-01-30T14:18:04+09:00</DateRegist>
　　<ApplicationStartDay>2009-01-30T00:00:00+09:00</ApplicationStartDay>
　　<StartDayDisplay/>
　　<SubTitle/>
　　<ReferenceName/>
　　<ReferenceAddress/>
　　<TargetUser/>
　　<NewsBody/>
    <HtmlEditorType>
      <HtmlEditorTypeId>1</HtmlEditorTypeId>
      <HtmlEditorTypeName>エディタ</HtmlEditorTypeName>
    </HtmlEditorType>
　　<SpeakerList>
　　　<Speaker>
　　　　<SpeakerId>4</SpeakerId>
　　　</Speaker>
　　</SpeakerList>
　　<ReferenceTel/>
　　<Attribute6>24</Attribute6>
　　<Price>1000</Price>
　　<StartDay>2013-01-30T13:00:00+09:00</StartDay>
　　<DateUpdate>2009-01-30T14:19:02+09:00</DateUpdate>
　　<SsTargetType>
　　　<SsTargetTypeName>サブキャンペーン</SsTargetTypeName>
　　　<SsTargetTypeId>2</SsTargetTypeId>
　　</SsTargetType>
　　<HallAddress/>
　　<Attribute2List>
　　　<Attribute2>
　　　　<Attribute2Name>１</Attribute2Name>
　　　　<Attribute2Id>1</Attribute2Id>
　　　</Attribute2>
　　</Attribute2List>
　　<PriceDisplay/>
　　<HallNote/>
　　<ReferenceNote/>
　　<Summary/>
　　<Title>テストサブキャンペーンA-1</Title>
　　<Detail/>
　　<EndDay>2013-01-30T14:00:00+09:00</EndDay>
　　<LimitUserNumDisplay/>
　　<HallName/>
　　<ApplicationEndDay>2013-01-29T00:00:00+09:00</ApplicationEndDay>
　　<Notes/>
　　<Attribute7SlaveAlt>サブキャンペーン代替</Attribute7SlaveAlt>
　　<Id>19</Id>
　　<TimetableNotes/>
　　<HallMapUrl/>
　　<PaymentFlag>
　　　<PaymentFlagName>有料</PaymentFlagName>
　　　<PaymentFlagId>2</PaymentFlagId>
　　</PaymentFlag>
　　<SessionCategory>
　　　<SessionCategoryName>基調講演</SessionCategoryName>
　　　<SessionCategoryId>1</SessionCategoryId>
　　</SessionCategory>
　　<ReferencePersonInCharge/>
　　<Code>A-1</Code>
　　<Seminar>
　　　<SeminarId>26</SeminarId>
　　　<SeminarName>テストキャンペーンサブキャンペーン型その７サブキャンペーン追加属性のファイル・画像 </SeminarName>
　　</Seminar>
　　<ApplicationStartDayDisplay/>
　　<HallZipcode/>
　　<Attribute7>23</Attribute7>
　　<Attribute3List>
　　　<Attribute3>
　　　　<Attribute3Id>3</Attribute3Id>
　　　　<Attribute3Name>３</Attribute3Name>
　　　</Attribute3>
　　</Attribute3List>
　</Session>
　<Session>
　　<HallFile/>
　　<LimitUserNum>20</LimitUserNum>
　　<ReferenceEmail/>
　　<Attribute1>テストサブキャンペーン</Attribute1>
　　<ReferenceFax/>
　　<HallTel/>
　　<Memo/>
　　<DateRegist>2009-01-05T18:41:24+09:00</DateRegist>
　　<ApplicationStartDay>2009-01-05T00:00:00+09:00</ApplicationStartDay>
　　<StartDayDisplay/>
　　<SubTitle/>
　　<ReferenceName/>
　　<ReferenceAddress/>
　　<TargetUser/>
　　<NewsBody/>
　　<SpeakerList/>
　　<ReferenceTel/>
　　<Price>6000</Price>
　　<StartDay>2013-01-05T10:00:00+09:00</StartDay>
　　<DateUpdate>2009-01-05T18:41:24+09:00</DateUpdate>
　　<SsTargetType>
　　　<SsTargetTypeName>サブキャンペーン</SsTargetTypeName>
　　　<SsTargetTypeId>2</SsTargetTypeId>
　　</SsTargetType>
　　<HallAddress/>
　　<Attribute2List>
　　　<Attribute2>
　　　　<Attribute2Name>１</Attribute2Name>
　　　　<Attribute2Id>1</Attribute2Id>
　　　</Attribute2>
　　</Attribute2List>
　　<PriceDisplay>6000</PriceDisplay>
　　<HallNote/>
　　<ReferenceNote/>
　　<Summary/>
　　<Title>テストサブキャンペーンAの１リード</Title>
　　<Detail/>
　　<EndDay>2013-01-05T16:00:00+09:00</EndDay>
　　<LimitUserNumDisplay/>
　　<HallName/>
　　<ApplicationEndDay>2013-01-04T00:00:00+09:00</ApplicationEndDay>
　　<Notes/>
　　<Id>18</Id>
　　<TimetableNotes/>
　　<HallMapUrl/>
　　<PaymentFlag>
　　　<PaymentFlagName>有料</PaymentFlagName>
　　　<PaymentFlagId>2</PaymentFlagId>
　　</PaymentFlag>
　　<SessionCategory>
　　　<SessionCategoryName>基調講演</SessionCategoryName>
　　　<SessionCategoryId>1</SessionCategoryId>
　　</SessionCategory>
　　<ReferencePersonInCharge/>
　　<Code>A-1</Code>
　　<Seminar>
　　　<SeminarId>25</SeminarId>
　　　<SeminarName>テストキャンペーンサブキャンペーン型その６リード</SeminarName>
　　</Seminar>
　　<ApplicationStartDayDisplay/>
　　<HallZipcode/>
　　<Attribute3List>
　　　<Attribute3>
　　　　<Attribute3Id>1</Attribute3Id>
　　　　<Attribute3Name>１</Attribute3Name>
　　　</Attribute3>
　　</Attribute3List>
　</Session>
</SessionList>

制限事項

なし