資料情報取得API

SMPの資料情報を参照するための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>

制限事項

なし