SHANON MARKETING PLATFORM API GUIDE
  • APIの利用方法
    • APIの利用方法
    • 認証
    • APIコールとメソッドリファレンス
    • 検索
    • 登録・更新
  • クライアントアプリケーション認証
    • authentication.get
  • 画面ユーザ認証
    • authapi.login
    • authinfo.getToken
    • authinfo.getCheck
    • authinfo.logout
    • authapi.agencynavigation
    • authapi.agencynavigation.back
  • 管理者
    • admin.get
    • admin.post
    • admin.put
    • admin.delete
  • キャンペーン
    • seminar.get
    • seminar.post
    • seminar.put
    • seminar.delete
    • seminaritemsetting.get
    • seminar.getSession
    • seminar.postSession
    • seminar.putSession
    • seminar.deleteSession
    • sessionitemsetting.get
  • 担当者割当
    • admin.getAssinmentSeminar
    • admin.postAssinmentSeminar
    • admin.deleteAssinmentSeminar
  • アンケート
    • enquetetemplate.get
    • enquetetemplate.getQuestion
  • 講演者
    • speaker.get
    • speakersetting.get
  • 資料
    • document.get
  • リスト
    • staticlist.get
    • staticlist.post
    • staticlist.put
    • staticlist.delete
  • リスト・リード管理
    • staticlist.getVisitor
    • staticlist.postVisitor
    • staticlist.deleteVisitor
  • 企業
    • company.get
    • company.post
    • company.put
    • company.delete
  • 企業・リード管理
    • company.getVisitor
    • company.postVisitor
    • company.deleteVisitor
  • リード
    • visitor.get
    • visitor.post
    • visitor.put
    • visitor.delete
    • visitor.getFile
    • visitor.postFile
    • visitor.putFile
    • visitor.deleteFile
    • visitorsetting.get
  • 申込
    • application.post
    • application.delete
    • seminar.getDiscount
    • visitor.getDiscounthistory
    • visitor.getBilling
    • visitor.getApplication
    • visitor.putApplication
    • counting.getApplication
  • キャンペーン申込情報
    • visitor.getApplicationSeminar
    • visitor.getApplicationSession
  • 申込フロー
    • seminar.getFlow
  • 来場
    • visitor.getAttendance
    • visitor.getAttendanceSeminar
    • visitor.postAttendanceSeminar
    • visitor.deleteAttendanceSeminar
    • visitor.getAttendanceSession
    • visitor.postAttendanceSession
    • visitor.deleteAttendanceSession
    • counting.getAttendance
  • メール送信
    • visitor.postMail
    • 一斉メール送信APIの利用方法
    • mailtemplate.get
    • mailtemplate.post
    • mailtemplate.put
    • mailtemplate.delete
    • mailsender.get
    • mailsender.post
    • mailsender.delete
  • クリックカウント
    • clickcounturl.get
  • トラッキング
    • trackingurl.get
  • メール履歴情報
    • visitor.getMail
  • アンケート履歴情報
    • visitor.getEnquete
    • enquetehistory.get
  • クリックカウント履歴情報
    • visitor.getClickcount
  • トラッキング履歴情報
    • visitor.getTrackingaccesslog
    • visitor.getTrackingsession
  • 資料履歴情報
    • visitor.getDocumentdownload
  • 活動履歴情報
    • visitor.getActivity
    • visitor.postActivity
    • visitor.putActivity
    • visitor.deleteActivity
    • activitysetting.get
  • リード変更履歴情報
    • visitor.getChangelog
    • visitor.getAddlog
    • visitor.getDeletelog
    • visitor.getMergelog
  • DM個別送信履歴情報
    • visitor.getDirectMail
  • キャンペーン設定
    • seminarsettingdata.get
    • seminarsettingdata.put
  • メッセージ
    • messagestr.get
    • messagestr.put
  • ファイル情報
    • file.get
    • file.post
  • 検索条件
    • searchcondition.get
  • バルクAPI
    • 概要
    • bulkapi.get
    • bulkapi.post
  • APPENDIX
    • APIメソッドリファレンス
    • 用語について
    • 共通エラーコード一覧
    • 都道府県IDと都道府県名の対応表
    • タイムゾーンIDとタイムゾーン名の対応表
    • 非推奨API
    • 改訂履歴
Home >> Document.get

資料情報取得API

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

メソッド名

document.get

リクエスト情報

アクセスURL

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

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
DocumentCategoryId ○ ○ 資料カテゴリーID
SsTargetTypeId ○ ○ キャンペーンタイプID
1: キャンペーン
2: サブキャンペーン
SsDataId ○ ○ SsDataIdの内容はSsTargetTypeIdの値によって変わります。
SsTargetTypeId=1の場合 :
SsDataId=キャンペーンID
SsTargetTypeId=2の場合 :
SsDataId=サブキャンペーンID
Name ○ ○ 資料名
PublicationTypeId ○ ○ 公開タイプID
1 : 非公開
2 : 検索条件でフィルタされた会員
3 : 会員
4 : すべて公開
StartDay ○ ○ 公開開始日時
YYYY-mm-ddTHH:MM:SS+09:00
EndDay ○ ○ 公開終了日時
YYYY-mm-ddTHH:MM:SS+09:00
DateRegist ○ ○ 登録日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate ○ ○ 更新日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
PreserveSearchConditionId ◯ × リードの検索条件フィルタ

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード 内容
200 正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名:Document ★ データ型:DocumentType

カラム名 データ型 内容
Id string 資料ID
DocumentCategory DocumentCategoryType 資料カテゴリータイプ
DocumentCategoryId:DocumentCategoryName
SsTargetType SsTargetTypeType キャンペーンタイプID
SsTargetTypeId:SsTargetTypeName
1:: キャンペーン
2:サブキャンペーン
SsDataId string SaDataIdの内容はSsTargetTypeIdの値によって変わります。
SsTargetTypeId=1の場合:
SsDataId=キャンペーンID
SsTargetTypeId=2の場合:
SsDataId=サブキャンペーンID
Name string 資料名
Summary string 概要
PreserveSearchCondition PreserveSearchConditionType リードの検索条件フィルタ
PreserveSearchConditionId:PreserveSearchConditionName
PublicationType PublicationTypeType 公開範囲
PublicationTypeId:PublicationTypeName
1: 非公開
2: 検索条件でフィルタされた会員
3: 会員
4: すべて公開
DocumentPublicationType

※非推奨カラムです。PublicationTypeを使用してください。
DocumentPublicationTypeType 資料公開タイプ
DocumentPublicationTypeId:DocumentPublicationTypeName
1 : 会員のみダウンロード可
2 : 非公開
3 : 全体に公開
NumberOfDownload nonNegativeInteger ダウンロード回数
StartDay dateTime 公開開始日
YYYY-mm-ddTHH:MM:SS+09:00
EndDay dateTime 公開終了日
YYYY-mm-ddTHH:MM:SS+09:00
DateRegist dateTime 登録日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate dateTime 更新日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<DocumentList xmlns="http://smartseminar.jp" version="1.1">
 <Document>
  <Id>1</Id>
  <DocumentCategory>
   <DocumentCategoryId>1</DocumentCategoryId>
   <DocumentCategoryName>一般向け資料</DocumentCategoryName>
  </DocumentCategory>
  <SsTargetType>
   <SsTargetTypeId>2</SsTargetTypeId>
   <SsTargetTypeName>サブキャンペーン</SsTargetTypeName>
  </SsTargetType>
  <SsDataId>1</SsDataId>
  <Name>サブキャンペーン1の資料</Name>
  <Summary>これはテストドキュメントです。</Summary>
  <DocumentPublicationType>
   <DocumentPublicationTypeId>1</DocumentPublicationTypeId>
   <DocumentPublicationTypeName>会員のみダウンロード可</DocumentPublicationTypeName>
  </DocumentPublicationType>
  <PublicationType>
   <PublicationTypeId>3</PublicationTypeId>
   <PublicationTypeName>会員</PublicationTypeName>
  </PublicationType>
  <StartDay>2009-07-01T00:00:00</StartDay>
  <EndDay>2009-08-31T00:00:00</EndDay>
  <NumberOfDownload>12</NumberOfDownload>
  <DateRegist>2009-06-30T20:09:02</DateRegist>
  <DateUpdate>2009-06-30T22:23:45</DateUpdate>
 </Document>
</DocumentList>

制限事項

なし