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 >> File.get

ファイル情報取得API

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

メソッド名

file.get

リクエスト情報

アクセスURL

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

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
Name ○ ○ ファイル名
Extension ○ ○ ファイル拡張子
Temporary ○ ○ テンポラリフラグ
0:使用済
1:未使用
DateRegist ○ ○ 登録日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate ○ ○ 更新日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード 内容
200 正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名:File ★ データ型:GenericFileType

カラム名 データ型 内容
Id string ファイルID
DateRegist dateTime 登録日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate dateTime 更新日時(JST)
YYYY-mm-ddTHH:MM:SS+09:00
Name string ファイル名
Extension string ファイル拡張子
Temporary string テンポラリフラグ
0:使用済
1:未使用
Body base64Binary データ(Base64エンコード)

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<FileList xmlns="http://smartseminar.jp/" version="1.5">
 <File>
  <Id>test</Id>
  <Extension>txt</Extension>
  <Temporary>1</Temporary>
  <Body>/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBhQSEBUUEhQVEB
  QUFRUUFhQVFRQUFBQUFBUVFRQVFRQYHCYeFxkjGR(途中略)
  5qcNn4/mrs2RZXDXKbgjB8lbcFE1vALashMQgCVCFQIQhAJEIQFkqEIEKAEqE
  AhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEH//2Q==</Body>
  <DateRegist>2011-04-11T20:54:26+09:00</DateRegist>
  <DateUpdate>2011-04-11T20:54:26+09:00</DateUpdate>
 </File>
</FileList>

制限事項

  • 一度に取得可能なファイルは1000件以内かつファイルサイズの合計200MBに制限され、それを超えるとエラーになります。

Base64エンコードデータにおけるHTML表示について

BodyをHTMLソースに記述する場合、下記のようにBase64でエンコードしたデータをそのままHTMLに記述することができます。

<img src="data:${MIMEパート名};base64,${Base64エンコードデータ}">

例:sample.pngのHTML表示

<img src="data:image/png;base64,iVBORw0KGgo...">