ドコモクラウドAPI技術資料 · if_xlb_r174 回転情報編集 4.0 画像の回転情報の編集を行う if_xlb_r175 コンテンツ削除 4.0 コンテンツの削除を行う

2018 NTT DOCOMO, INC. All Rights Reserved.

【dフォトAPI】

ドコモクラウドAPI技術資料

第1.38版

2018年4月11日

株式会社NTTドコモ

変更履歴

版数変更日変更箇所変更内容2.00 リクエスト情報

項番4　ゴミ箱指定の設定値欄及び備考欄修正レスポンス情報項番11　更新日時の説明欄修正

2.03 リクエスト情報項番1　OAuth認証スキームAuthorizationヘッダの説明欄を修正

2.04 リクエスト情報項番4　ファイル種別の設定値及び備考欄修正

2.20 概要欄からゴミ箱の記述を削除

2.21 IF名及び概要欄を修正リクエスト情報項番3　コンテンツGUIDの備考欄修正項番4　ステータスの設定値欄修正

2.23 リクエスト情報項番6　アルバムタグ名の文字列長最大値をnに修正（システム上は32文字が上限）業務外エラーマッピング

業務エラーマッピング廃止対象IFの記載を削除エラーコード1104は返却対象IFが無い為削除

エラーコード一覧 No3、6の説明欄を修正No8、10、11、17を削除

INDEX IF_XLB_R175のIF名修正以下のIFを削除IF_XLB_R162～IF_XLB_R167IF_XLB_R171～IF_XLB_R173IF_XLB_R176IF_XLB_R178IF_XLB_R179IF_XLB_R221IF_XLB_R062IF_XLB_R180IF_XLB_R181

2.23 リクエスト情報項番6　アルバムタグ名の文字列長最大値をnから32に修正

INDEX、2.30 IF_XLB_R222のIF名を修正（“複数”の誤字を削除）

表紙 CopyRightを2018に変更タイトルをdフォトAPIに変更

INDEX タイトルをdフォトが提供するAPIに変更

2.00 レスポンス情報項番12 フォトコレクション　を dフォトに変更

2.04 RESTレスポンス　基本情報備考　フォトコレクションをdフォトに変更

1.36

2016/07/15

1.36

1.37

2016/08/23

1.38

2018/04/11

変更履歴 - 2

INDEX

■ dフォトが提供するAPI

コンテンツとメタデータの操作

IF_XLB_R090 コンテンツIDリスト取得 2.0 コンテンツのメタデータ（コンテンツIDなど）を取得する。基準日時を指定することで更新差分を得ることができる。

IF_XLB_R080 コンテンツ削除履歴取得 2.0 削除済みコンテンツの一覧を取得する。

IF_XLB_R076 コンテンツ情報取得(原本・リサイズ) 2.0 コンテンツの原本またはリサイズのファイルを取得する。

IF_XLB_R077 コンテンツ情報取得(サムネイル) 2.0 コンテンツのサムネイル画像を取得する。

IF_XLB_R046 アップロード 1.0 原本データの登録ができる。

IF_XLB_R174 回転情報編集 4.0 画像の回転情報の編集を行う

IF_XLB_R175 コンテンツ削除 4.0 コンテンツの削除を行う

IF_XLB_R177 アップロード（タグ付き） 4.0 コンテンツ(原本)を登録する。

IF_XLB_R222 コンテンツ情報取得(サムネイル) 4.0 コンテンツのサムネイル画像を取得する。

IF_SLB_R100 分割アップロード（UploadIDの取得） 4.0 分割アップロードのためのUPLOADIDを取得する

IF_SLB_R101 分割アップロード（分割アップロード） 4.0 画像を分割アップロードする

IF_SLB_R102 分割アップロード（アップロード確定） 4.0 分割アップロードの確定をする

共通機能IF_XLB_R045 空き容量確認 1.0 ストレージの空き容量を取得することができる。

IFID インタフェース名称IFバージョン

概要

※上記APIの他、「タグ情報（グループ情報）を取得する」APIも提供しております。

興味をお持ち頂いた方は、photo‐colle‐[email protected] までご連絡をお願いいたします。

後日、担当者より、ご連絡をさせて頂きます。

INDEX - 3

共通規定

1. プロトコル

各IFに特別な記述が無い限り、下記のプロトコルのRFCに従って作成すること

プロトコル： HTTP over TLS

HTTPバージョン： 1.1

TLSバージョン： 1.0~1.2

TLS暗号スイート： TLS_ RSA_WITH_AES_256_CBC_SHA

TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030)

2. リクエストヘッダ

クライアントはサーバの公開インタフェースにアクセスする際、取得したアクセストークンを

"Bearer"認証スキームを利用して、"Authorization" HTTPヘッダフィールドに設定する。

詳細はIF仕様書、あるいはOAuth2.0 Beare Tokenの仕様書（下記URL）を参照のこと。

http://tools.ietf.org/html/rfc6750#section-2.1

3. レスポンスヘッダ

サーバは、レスポンスヘッダに Transfer-Encoding: chunked を設定したうえで、HTTP/1.1 の

規定に従いエンティティ・ボディをチャンク形式でエンコードすることがある。

4. メッセージフォーマット

(1) メッセージフォーマットは原則としてJSONを採用する。

(2) JSONの構文等は RFC 4627 に従う。

(3) 各ＩＦで特別に記載されない限り、メッセージ中の各種エスケープについては

基本的にはメッセージ形式に応じて下記RFC等で規定される内容に従う。

・JSON形式の場合　：RFC 4627

・XML形式の場合　：XML1.1勧告（W3C）：http://www.w3.org/TR/xml11/

・FORM形式の場合　：RFC 3986

ただし、以下ケースについては下記の対応を行うこと

・「FORM」形式における「リスト項目」の場合

項目値としてリスト形式での設定ができ、かつ値としてカンマを許容しているケースでは、

URLエンコードを行う前にカンマをエスケープすること

また、リスト指定できない項目について、値としてカンマを許容しているケースでは本対応は実施しないこと

例) 項目「AAA」に「1,2」「3」をリストで設定しリクエストする場合

AAA=1,2,3

↓ ※カンマをエスケープ

AAA =1,2,3

↓ ※URLエンコード

AAA = 1%26%23044%3b2%2c3

↓

リクエスト送信

共通規定 - 4

http://tools.ietf.org/html/rfc6750

5. 日付・時刻のフォーマット

(1) 日付・時刻のフォーマットは RFC 3339 に従い、string型で表現する。

(2) サーバが設定する日時・時刻項目の time-offset は、個別に記載がない限り、"+09:00" とする。

(3) リクエストパラメータの日時・時刻項目の time-offset は、個別に記載がない限り、任意とする。

参考： RFC 3339 における日付・時刻フォーマットのABNF

date-fullyear = 4DIGIT

date-month = 2DIGIT ; 01-12

date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on month/year

time-hour = 2DIGIT ; 00-23

time-minute = 2DIGIT ; 00-59

time-second = 2DIGIT ; 00-58, 00-59, 00-60 based on leap second rules

time-secfrac = "." 1*DIGIT

time-numoffset = ("+" / "-") time-hour ":" time-minute

time-offset = "Z" / time-numoffset

partial-time = time-hour ":" time-minute ":" time-second [time-secfrac]

full-date = date-fullyear "-" date-month "-" date-mday

full-time = partial-time time-offset

date-time = full-date "T" full-time

6. 一覧取得系インタフェースにおけるページング制御

(1) 一覧取得系インタフェースでは、1リクエストに対して返却する結果リスト件数を制限するために、ページン

グ制御を行う。

(2) 検索結果リストの各レコードには順序番号が（ソート条件に従い）ふられていると考え、以下の条件を満た

すレコードの集合を1回のリクエストに対し返却する。

開始番号 <= レコード順序番号 <= 開始番号 + 最大返却件数 -1

・開始番号, 最大返却件数はクライアントがリクエストパラメータで指定する。

・ソート条件はインタフェースによって、リクエストパラメータで指定する場合と、固定的に決められている

場合とがある。

(3) レスポンスには「次ページ開始番号」という項目を設けている。クライアントは次ページをリクエストする際、

リクエストの「開始番号」に前回のレスポンスの「次ページ開始番号」をセットすることで、順番に検索結果

を得ることができる。

(4) 最終ページに到達した場合、サーバは「次ページ開始番号」に0を設定して返却する。

7. エラー応答

エラー応答形式とパターンは、「エラー応答形式」シートを参照のこと。

共通規定 - 5

メッセージフォーマット凡例

セクション項目名説明

リクエスト情報種別パラメータの配置場所や形式による種別を表す。

レスポンス情報 URI Path リクエストURIのパス名に埋め込まれたパラメータ

URI Query リクエストURIのクエリパラメータ

HTTP Header HTTPヘッダ（Cookie以外; 特記すべきもののみ記載）Cookie HTTPヘッダにセットされるCookie（特記すべきもののみ記載）

HTTP Body HTTPエンティティボディ（に直接データが入る）

Form application/x-www-form-urlencoded またはmultipart/form-data 形式のボディにセットされるフォームパラメータ

JSON Element JSONオブジェクトのメンバ (Member)、または配列の要素 (Element) となる項目

XML Element XML要素 (Element)

XML Attribute XML要素の属性 (Attribute)

階層 JSONまたはXML要素の階層番号。

論理項目名 -

物理項目名 -

データ型以下のいずれか

string 文字列

number 数値（任意精度の符号付小数）

int 32ビット符号付整数 (-231

～ +(231

-1))long 64ビット符号付整数 (-2

63 ～ +(2

63-1))

array 配列

object オブジェクト

null

項目出現数（最小/最大）

null不可

URI Path null は、空文字列（文字列長=0）と同義とする。※Path上のパラメータ位置は固定なので、項目出現数を1と見なし、本基準を適用する

URI QueryHTTP HeaderCookieForm

"key=" のように、項目名あり＋値指定なしの値をnull と定義する。　・文字列項目の場合、null は空文字列　　（文字列長=0）と同義である　　　∴ 文字列長≧1 ⇒ NULL不可，　　　　　文字列長≧0 ⇒ NULL可　となる　・数値項目の場合、null と 0 とは区別される

JSON Element null値は「null」（ダブルクォートで囲まない）と表記される(RFC 4627通り)。（例） "key" : null

XML ElementXML Attribute

本システムでは null を許容しない（必ずnull不可）。→「値なし」を表現したい場合は、要素そのものを省略(項目出現数=0)すること

（以下参考） XML要素における null の定義。nil属性に"true"が設定された要素の値を null とする。前提として、XMLスキーマを用意し、その要素定義において nillable="true" が設定されていること。（例） <key xsi:nil="true"></key>

省略時値

数値（最小/最大）文字列長（最小/最大）設定値項目書式や取りうる値の詳細など。

説明項目の意味、用途などの説明。

項目出現数=0は、値だけでなく項目名も省略することを表す。XMLスキーマにおける minOccurs, maxOccurs に相当。「階層」≧2の場合は、ひとつ上の「階層」の項目1件に対しての当該項目の出現数とする。（つまり、ひとつ上の階層が項目出現数=0を許容するか否かには依存しない）

○は、項目が出現した場合で値に null を許容しないことを表す。nullの定義は以下の通りである。

項目が省略（項目出現数=0）された場合、または null値が指定された場合に適用されるデフォルト値。

データ型が number, int, long の場合、当パラメータの（IF仕様として規定する）最小/最大値と不等号（＞/≧/≦/＜）。データ型が string の場合に、当パラメータの（IF仕様として規定する）文字数の最小/最大値。

凡例 - 6

≧ ≦

≧

- 以下のいずれか1：撮影日の降順2：撮影日の昇順3：更新日時の降順4：更新日時の昇順5：アップロード日時の昇順6：アップロード日時の降順

（ページング条件）検索結果（コンテンツリスト）のソート条件。

1 1 ○ -9 JSONElement

1 ソート指定 sort_type int

1 - -8 JSONElement

1 開始番号 start int

- - -

- （ページング条件）検索結果全体のうち、レスポンスとして返却するレコードの開始番号。※検索結果の総件数を上回る値が指定された場合は、「コンテンツ数=0」で正常応答する

0 1 ○ 1

- （ページング条件）検索結果全体のうち、レスポンスとして返却する最大件数（ページサイズ）※内部的には上限値と省略時値は、それぞれプロパティで定義する可変値とする

0 1 ○ 1007 JSONElement

1 最大返却件数 max_results int

- - 206 JSONElement

1 更新日時（最小値） min_date_modified string

1 100 -

25 RFC 3339 の date-time フォーマットで秒の1の位まで指定タイムゾーンは任意に設定してよい yyyy-mm-ddThh:mi:ss+09:00 (JSTの例) yyyy-mm-ddThh:mi:ssZ (UTCの例)

（フィルタ条件）コンテンツの更新日時が本項目値以上のもの※「アップロード日時（最小値）」と同時に指定することは認めない

0 1 ○ -

25 RFC 3339 の date-time フォーマットで秒の1の位まで指定タイムゾーンは任意に設定してよい yyyy-mm-ddThh:mi:ss+09:00 (JSTの例) yyyy-mm-ddThh:mi:ssZ (UTCの例)

（フィルタ条件）コンテンツのアップロード日時が本項目値以上のもの※「更新日時（最小値）」と同時に指定することは認めない


1 アップロード日時（最小値）

min_date_upload string

- - -4 JSONElement

1 ごみ箱指定 dustbox_condition int

- - 20

- 1 : ごみ箱以外のコンテンツ（固定値）0 1 ○ -

- 以下のいずれか1:静止画，2:動画，3スライドムービー

（フィルタ条件）コンテンツのメディア種別


1 画像種別コード file_type_cd int

- - 12 JSONElement

1 プロジェクション projection string

- - -

詳細は「共通規定」 2を参照1 1 ○ -

1 固定値　3 : 詳細情報（タグ情報無）返却データ項目セットの範囲1 1 ○ -

1 HTTPHeader

- OAuth認証スキームAuthorizationヘッダ

Authorization string

数値文字列長設定値

- - - -

説明最小最大最小最大最小最大データ型項目出現数 null

不可省略時値

リクエスト情報

項番種別階層論理項目名物理項目名

5 文字コード UTF-8

6 備考

・各（フィルタ条件）項目は、全てAND条件として検索に適用される。・省略可能な（フィルタ条件）項目の指定を省略すると、当該フィルタは適用されない（ただし省略時値が定義されている場合は省略時値が適用される）。・（ページング条件）の説明は「共通規定」を参照のこと。

3 入力形式 JSON4 Content-Type application/json

1 HTTPメソッド POST

2 リクエストURIhttps://xlb.photocolle-docomo.com/file_a2/2.0/ext/file_search/get_list

概要

コンテンツのメタデータを検索し返却する。

REST リクエスト　基本情報

項番項目名内容

インタフェース仕様書

インタフェースID/インタフェース名称

インタフェースバージョン

IF_XLB_R0902.0

コンテンツIDリスト取得

2.00 - 7

https://xlb.photocolle-docomo.com/file_a2/2.0/ext/file_search/get_list



≧

≧

≧

300 エラー発生箇所をリクエスト項目で特定できる場合に、エラーの発生した「エラー項目」の値がセットされる。


1 エラー項目値 param_value string

- - 13 JSONElement

1 エラー項目 param_name string

- - 1

64 エラー発生箇所をリクエスト項目で特定できる場合に、その物理項目名がセットされる。

0 1 ○ -

- 設定値については「業務エラーマッピング」シート参照

エラーの詳細内容を表すコード。詳細は、「業務エラーコード一覧」

1 1 ○ -2 JSONElemen

1 エラーステータスコード

err_cd int

- - -1 JSONElemen

1 処理結果 result int

- - -

- 1 ：失敗処理結果が正常か失敗かを示す。

1 1 ○ -

設定値説明最小最大最小最大最小最大項目出現数 null

不可省略時値

数値文字列長XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型

レスポンス情報

HTTP ステータス 200 意味処理失敗備考

- - -14 JSONElement

3 リサイズNGフラグ resize_ng_flg string - 0:リサイズOK 1:リサイズNG1 1 ○ -

- 原本のファイルサイズ(単位はbyte)※（参考）サービス仕様上の最大サイズは30MB


3 ファイルサイズ file_data_size long

- - 2512 JSONElement

3 アップロード日時 upload_datetime string

0 - -

25 RFC 3339 の date-time フォーマットで秒の1の位まで指定 yyyy-mm-ddThh:mi:ss+09:00

・画像種別コード=1,2の場合　dフォトにコンテンツをアップロード後、分析が完了した日時・画像種別コード=3の場合　スライドムービーの作成日時

1 1 ○ -


コンテンツ情報の最終更新日時。アップロード後に画像回転等の操作を行うと更新される。


3 更新日時 mdate string

- - 2510 JSONElement

3 撮影日（作成日） exif_camera_day string

- - 25


EXIFから取得した撮影日。ない場合はファイル作成日。

1 1 ○ -

- 1:静止画，2:動画，3:スライドムービーコンテンツのメディア種別1 1 ○ -9 JSONElement


- - 18 JSONElement

3 コンテンツファイル名

content_name string

- - -

2551 1 ○ -


3 コンテンツID content_guid string

- - -6 JSONElement

2 コンテンツ情報 content_info object

- - 1

-0 100 ○ -

- 検索条件を満たすコンテンツのリスト

※検索結果の「コンテンツ情報」件数=0の場合は、空（要素数=0）の array とする。 "content_list" : [ ]


1 コンテンツリスト content_list array

0 - -4 JSONElement

1 次ページ開始番号 next_page int

- - -

- ・次ページありの場合　　開始番号 + コンテンツ数・次ページなしの場合　　0

1 1 ○ -

- リクエストの開始番号と同じ値検索結果全体のうち、レスポンスとして返却するレコードの開始番号。



0 - -2 JSONElement

1 コンテンツ数 content_cnt int

1 - -

- 本レスポンスの返却コンテンツ数（コンテンツリストの要素数）

1 1 ○ -

- 0 ：成功処理結果が正常か失敗かを示す。



文字列長設定値説明

最小最大最小最大最小最大項目出現数 null

不可省略時値

数値

- - -

XML ROOT ELEMENT


4 備考


HTTP ステータス 200 意味正常備考

2 Content-Type application/json3 文字コード UTF-8

RESTレスポンス　基本情報

項番項目名内容1 出力形式 JSON

2.00 - 8

自動選択

≧ ≦

≧

自動選択

≧ ≦

≧

≧




- - 13 JSONElement


- - 1


0 1 ○ -





err_cd int

- - -1 JSONElement


- - -


1 1 ○ -


不可省略時値





- - 16 JSONElement

2 コンテンツGUID content_guid string 500 100 ○ -

- 削除済みコンテンツのリスト1 1 ○ -5 JSONElement

1 コンテンツリスト content_list array

0 - -4 JSONElement

1 次ページ開始番号 next_page int

- - -

- ・次ページありの場合　　開始番号 + コンテンツ数・次ページなしの場合　　0

0 1 ○ -

- リクエストの開始番号と同じ値検索結果全体のうち、レスポンスとして返却するレコードの開始番号。



0 100 -2 JSONElement

1 コンテンツ数 content_cnt int

1 - -

- 本レスポンスの返却コンテンツ数（コンテンツリストの要素数）

1 1 ○ -






不可省略時値

数値

- - -

XML ROOT ELEMENT


4 備考レスポンスは取得した項目の登録日の昇順（古いものから）でソートし、返却する。






- （ページング条件）検索結果全体のうち、レスポンスとして返却するレコードの開始番号。※検索結果の総件数を上回る値が指定された場合は、「コンテンツ数=0」で正常応答する

0 1 ○ 15 JSONElement


1 100 -4 JSONElement

1 最大返却件数 max_results int

1 - -

- （ページング条件）検索結果全体のうち、レスポンスとして返却する最大件数（ページサイズ）※内部的には上限値と省略時値は、それぞれプロパティで定義する可変値とする

0 1 ○ 100

25 RFC 3339の date-time フォーマットタイムゾーンは任意に設定してよいyyyy-mm-ddThh:mi:ss+09:00 (JSTの例)yyyy-mm-ddThh:mi:ssZ (UTCの例）

（フィルタ条件）コンテンツの削除日時が本項目値以上のもの


1 削除日時（最小日） min_date_deleted string

1 1 12 JSONElement


- - 20


1 以下のいずれか1:静止画，2:動画，3スライドムービー

（フィルタ条件）コンテンツのメディア種別

1 1 ○ -

1 HTTPHeader




- - - -

説明最小最大最小最大最小最大

データ型項目出現数 null

不可省略時値




6 備考

・各（フィルタ条件）項目は、全てAND条件として検索に適用される。・省略可能な（フィルタ条件）項目の指定を省略すると、当該フィルタは適用されない（ただし省略時値が定義されている場合は省略時値が適用される）。・（ページング条件）の説明は「共通規定」を参照のこと。



2 リクエストURIhttps://xlb.photocolle-docomo.com/file_a2/2.0/ext/content/get_delete_history

概要

削除されたコンテンツの情報を取得する。






IF_XLB_R0802.0

コンテンツ削除履歴取得

2.03 - 9




- - 13 JSONElement


- - 1


0 1 ○ -





err_cd int

- - -1 JSONElemen


- - -


1 1 ○ -


不可省略時値





- - -2 HTTPBody

コンテンツ - OutputStream

- コンテンツのバイナリデータ1 1 ○ -

- 以下のいずれかimage/jpegimage/pjpegimage/pngvideo/3gppvideo/avivideo/quicktimevideo/mp4video/vnd.mtsvideo/mpegvideo/x-m4v

1 1 ○ -1 HTTPHeader

Content-Type Content-Type string



不可省略時値

数値

- - -

XML ROOT ELEMENT


4 備考

1. リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。2. リサイズ画像のEXIFは、Orientation以外は原本と同じ内容である。3. リサイズ画像は、原本画像を原本のEXIF-Orientationで補正した向きに回転加工されている。これに伴いリサイズ画像のEXIF-Orientation=1固定となっている。4. dフォトの画面上でユーザが画像を回転させた結果は「IF_XLB_R074 コンテンツIDリスト取得（タグ詳細付）」レスポンスの「回転情報」に反映される。この「回転情報」はリサイズ画像（上記3）に対する補正角度である。原本画像の向きを補正するためには、「回転情報」に加えて原本のEXIF-Orientationを反映する必要がある。



2 Content-Type3 文字コード UTF-8


項番項目名内容1 出力形式

- 以下のいずれか1 : 原本、2 : リサイズ画像


1 ファイル種別 resize_type_cd int

- - 13 JSONElement


- - -

50 取得対象画像のファイルID1 1 ○ -

- 以下のいずれか1 : 静止画、2 : 動画、3 : アルバム



- - -1 HTTPHeader



- - -

- 詳細は「共通規定」 2を参照1 1 ○ -

数値文字列長設定値説明

最小最大最小最大最小最大データ型項目出現数 null

不可省略時値



5 文字コード UTF-86 備考


2 リクエストURIhttps://xlb.photocolle-docomo.com/file_a2/2.0/ext/content/get

概要

コンテンツ（原本・リサイズ）の画像データを取得する。






IF_XLB_R0762.0

コンテンツ情報取得(原本・リサイズ)


2.04 - 10

https://xlb.photocolle-docomo.com/file_a2/2.0/ext/content/get

https://xlb.photocolle-docomo.com/file_a2/2.0/ext/content/get

#




- - 13 JSONElement


- - 1


0 1 ○ -





err_cd int

- - -1 JSONElemen


- - -


1 1 ○ -


不可省略時値





- - 16 JSONElement

3 サムネイル画像 thumbnail string - Base64エンコードされたサムネイルの画像データ。

1 1 ○ -

- image/jpeg 画像のメディアタイプ1 1 ○ -5 JSONElement

3 MIMEタイプ mime_type string

- - 14 JSONElement


- - 1

50 リクエストのコンテンツIDと同じ1 1 ○ -

-1 30 ○ -3 JSONElement


- - -2 JSONElement

1 コンテンツ情報リスト content_info_list array

- - -

-1 1 ○ -

1 0 ：成功処理結果が正常か失敗かを示す。





不可省略時値

数値

- - 1

XML ROOT ELEMENT


4 備考リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。








- - -2 JSONElement

1 コンテンツIDリスト content_info_list array

- - 1


-1 1 ○ -

1 HTTPHeader




- - - -


不可省略時値






2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/2.0/ext/thumbnail/get

概要

コンテンツのサムネイル画像を取得する。






IF_XLB_R0772.0

コンテンツ情報取得(サムネイル)

2.05 - 11

https://xlb.photocolle-docomo.com/file_a2/2.0/ext/thumbnail/get

1 11

1 255

1 9

1 15

- -

1 別紙１の「２．状態に対応する内容」を参照

【PCアプリのみ】コンテンツの状態が設定される。

エラーステータスコードが「1101」の場合、必須となる。


1 状態 status string

- - 415 JSONElement

1 ファイルID data_id string

- - 1

41 【PCアプリのみ】エラーステータスコードが「1101」の場合は、重複したファイルIDを設定する。

0 1 ○ -

255 エラーが発生したリクエストの項目名が設定される。


1 エラー項目 err_item string

- - -3 JSONElement


err_cd string

- - 1


エラーの詳細内容を表すコード。詳細は、「業務エラーコード一覧」シート参照。

1 1 ○ -

- エラーが発生した場合に配列形式で設定される。


1 エラーリスト err_list array

- - -1 JSONElemen

1 処理結果 result string

- - -

- 1：失敗処理結果が正常か失敗かを示す。

1 1 ○ -


不可省略時値





- - 412 JSONElement

1 ファイルID data_id string

0 ：成功処理結果が正常か失敗かを示す。

1 1 ○ -

41 アップロードされたコンテンツのファイルIDが設定される。

コンテンツに対してサーバ側で採番された一意の値

1 1 ○ -

1 JSONElemen



不可省略時値

数値文字列長

- - 1 1

XML ROOT ELEMENT





2 Content-Type application/json

- -



1 1 ○ - 画像・動画データを設定する。画像の場合、最大30MBとなる。動画の場合、最大100MBとなる。拡張子を含んだ文字列、Content-Dispositionにfilenameが必要

5 Form 1 MIMEタイプ mime_type string

1 出力形式 JSON

6 Form 1 本文 file InputStream

1

- - ファイルのサイズ(byte)を設定する。画像の場合、1～30MBを設定する。動画の場合、1～100MBを設定す

1 ○ -

3

- - 画像の場合image/jpeg：JPEG画像image/pjpeg：PJPEG画像image/png：PNG画像

動画の場合video/3gpp：3GP動画(.3gp)video/avi：AVI動画(.avi)video/quicktime：(.mov)video/mp4：(mp4)video/vnd.mts：(.mts)video/mpeg：(m2ts)video/x-m4v：(m4v)

MIMEタイプを設定する。1 ○ -

4 Form 1 サイズ size string

1Form 1 ファイル名 title string

12 Form 1 ファイルタイプ type string

1


- - Image：画像の場合Video：動画の場合

画像や動画を設定する。1 ○ -

- - 拡張子を含んだ文字列1 ○ -

1 HTTPHeader




- - - -


不可省略時値



5 文字コード UTF-86 備考チャンク取得（Rangeリクエスト）は使用できない。

3 入力形式 MULTIPART4 Content-Type multipart/form-data


2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/1.0/docomo/create

概要

コンテンツ書き込みAPIを使用して原本データの登録が可能となる。






IF_XLB_R0461.0

アップロード

2.06 - 12

https://xlb.photocolle-docomo.com/file_a2/1.0/docomo/create

n エラー発生箇所をリクエスト項目で特定できる場合に、エラーの発生した「エラー項目」の値がセットされる。



- - 14 JSONElement


- - 1

n エラー発生箇所をリクエスト項目で特定できる場合に、その物理項目名がセットされる。

0 1 ○ -

n コンテンツID0 1 ○ -3 JSONElement


- - -2 JSONElement


err_cd int

- - 1

1：失敗処理結果が正常か失敗かを示す。

1 1 ○ -



1 1 ○ -

1 JSONElement



不可省略時値

数値文字列長

- - - -

XML ROOT ELEMENT



HTTP ステータス 200 意味異常備考

- - -1 JSONElement

1 処理結果 result int - 0 ：成功処理結果を下記の値で表す。0 ：成功1 ：失敗

1 1 ○ -



不可省略時値

数値XML ROOT ELEMENT


4 備考






- 0：回転しない90：右90度回転180：上下反転270：右270度回転(左90度回転)

・画像の向きを示す値を設定する1 1 ○ -3 JSONElement

1 画像の向き orientation int

- - 352 JSONElement


- - -


50 回転情報の変更を行うコンテンツのコンテンツIDを指定する

1 1 ○ -

1 HTTPHeader




- - - -


不可省略時値






2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/dtl/set_rotate

概要

指定されたコンテンツに対し、回転情報の編集を行う。






IF_XLB_R1744.0

回転情報編集

2.20 - 13




- - 14 JSONElement


- - 1


0 1 ○ -

n コンテンツID0 1 ○ -3 JSONElement


- - -2 JSONElement


err_cd int

- - 1

1：失敗処理結果が正常か失敗かを示す。

1 1 ○ -



1 1 ○ -

1 JSONElement



不可省略時値

数値文字列長

- - - -

XML ROOT ELEMENT




- - -1 JSONElement

1 処理結果 result int - 0 ：成功処理結果を下記の値で表す。0 ：成功1 ：失敗

※1ファイルでも操作が完了していれば成功とする。

1 1 ○ -



不可省略時値



4 備考






- 1：削除（固定値）1 1 ○ -4 JSONElement

1 ステータス status int

- - 353 JSONElement


- - -

50 ・削除を行うコンテンツのコンテンツIDを指定する。

※内部的には上限値はプロパティで定義する可変値とする

1 100 ○ -


1 コンテンツIDリスト content_guid_list array

- - -1 HTTPHeader



- - -


数値文字列長設定値説明

最小最大最小最大最小最大データ型項目出現数 null

不可省略時値





2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/dtl/set_trash

概要

コンテンツの削除を行う。






IF_XLB_R1754.0

コンテンツ削除


2.21 - 14




- - 13 JSONElement


- - 1


0 1 ○ -





err_cd int

- - -1 JSONElemen


- - -


1 1 ○ -


不可省略時値





- - 352 JSONElement

1 データID data_guid string 75 アップロードされたファイルのデータIDが設定される。

コンテンツに対してサーバ側で採番された一意の値

1 1 ○ -

- 0 ：成功処理結果を下記の値で表す。0 ：成功1 ：失敗





不可省略時値

数値

- - -

XML ROOT ELEMENT


4 備考






- ・'アップロードを行うファイル・拡張子を含んだ文字列、Content-Dispositionにfilenameが必要

1 1 ○ -7 Form 1 ファイル file InputStream

- - 16 Form 1 アルバムタグ名 optional_tag_name string

- - -

32 アップロードを行うコンテンツに対し、アルバムタグを付与する場合に、アルバムタグ名を設定する。URLエンコードした文字列

0 1 ○ -

15 【画像コンテンツ】image/jpeg　※JPEG画像image/pjpeg　※PJPEG画像image/png　※PNG画像【動画コンテンツ】video/3gpp　※3GP動画(.3gp)video/avi　※AVI動画(.avi)video/quicktime　※(.mov)video/mp4　※(.mp4)video/vnd.mts　※(.mts)video/mpeg　※(m2ts)video/x-m4v　※(.m4v)

アップロードを行うコンテンツのMIMEタイプを設定する。

1 1 ○ -5 Form 1 MIMEタイプ mime_type string

- - 14 Form 1 ファイルデータサイズ file_data_size string

- - 1

10 アップロードを行うコンテンツのファイルサイズを設定する。

1 1 ○ -

255 アップロードを行うコンテンツのファイル名を設定する。URLエンコードした文字列

1 1 ○ -3 Form 1 ファイル名 file_name string

- - 12 Form 1 画像種別コード file_type_cd string

- - 1


1 1 : 画像、2 : 動画1 1 ○ -

1 HTTPHeader




- - - -


不可省略時値




3 入力形式 MULTIPART4 Content-Type multipart/form-data


2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/content/create

概要

コンテンツ(原本)を登録する。コンテンツ登録と同時にアルバムタグの割当を行うことができる。ただし、アルバムタグが１ユーザの上限に達している場合は、アルバムタグは付与されない。






IF_XLB_R1774.0

アップロード（タグ付き）

2.23 - 15




- - 13 JSONElement


- - 1


0 1 ○ -





err_cd int

- - -1 JSONElement


- - -


1 1 ○ -


不可省略時値





- - 18 JSONElement

2 取得失敗コンテンツIDng_content_guid string 50 取得できなかったコンテンツID1 99 ○ -


1 取得失敗リスト ng_list array

- - 16 JSONElement

3 サムネイル画像 thumbnail string

- - -

- Base64エンコードされたサムネイルの画像データ。

1 1 ○ -

- image/jpeg 画像のメディアタイプ1 1 ○ -5 JSONElement

3 MIMEタイプ mime_type string

- - 14 JSONElement


- - 1

50 取得できたコンテンツID1 1 ○ -



- - -2 JSONElement

1 コンテンツ情報リスト content_info_list array

- - -

- 処理結果が正常の場合必須1 1 ○ -

1 0 ：成功処理結果が正常か失敗かを示す。





不可省略時値

数値

- - 1

XML ROOT ELEMENT


4 備考リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。








- - -2 JSONElement

1 コンテンツIDリスト content_info_list array

- - 1


-1 1 ○ -

1 HTTPHeader




- - - -



不可省略時値






2 リクエストURIhttps://xlb.photocolle-docomo.com/file_a2/4.0/ext/thumbnail_list/get

概要

コンテンツのサムネイル画像を取得する。






IF_XLB_R2224.0

コンテンツ情報取得（サムネイル）

2.30 - 16

https://xlb.photocolle-docomo.com/file_a2/4.0/ext/thumbnail_list/get

https://xlb.photocolle-docomo.com/file_a2/4.0/ext/thumbnail_list/get

自動選択

自動選択

641 1 ○1 JSONElement

1 アップロードID uploadID string



不可省略時値

数値

- - 64

XML ROOT ELEMENT


4 備考






- 詳細は「メタ情報」を参照1 1 ○5 JSONElement

1 GSCT情報 object

- - 14 HTTPHeader

1 クライアントハッシュ X-kii-client-hash string

- - -

64 このヘッダを送信した場合、2.32、2.33以降も同じ値を送信する必要があります。アップロード中のファイル変更があり得る場合は使用を推奨します。

0 1

- 詳細は「共通規定」 2を参照1 1 ○ -3 HTTPHeader

1 OAuth認証スキームAuthorizationヘッダ


- - 62 HTTPHeader

1 アプリケーションキー

X-kii-appkey string

- - -

1 1 ○

6 固定値"DOCOMO"1 1 ○ -

1 HTTPHeader

1 アプリケーションID X-kii-appid string


- - 6 6 固定値"DOCOMO"



不可省略時値




6 備考

・X-kii-client-hash はオプションです。このヘッダを付与した場合、 2.32、2.33 以降の⼿順で同じ値をif-Matchヘッダとして指定する必要があります。

3 入力形式 JSON4 Content-Type application/vnd.com.kii.sync.Generic2+json


2 リクエストURI https://slb.photocolle-docomo.com/app/dcm_slb/api/0.8/Generic2/uploads

概要

アップロードするコンテンツのメタ情報をJSON形式でサーバにPOSTで送信します。成功するとサーバはUpload IDを応答します。このUpload IDは 2.32、2.33 以降で必要となります。






IF_SLB_R1004.0

分割アップロード（UploadIDの取得）

2.31 - 17

自動選択

自動選択



不可省略時値



4 備考



2 Content-Type3 文字コード


項番項目名内容1 出力形式 Bodyなし

- チャンクデータ(バイナリ)1 1 ○7 HTTPBody

1 チャンクデータ binary

- - 106 HTTPHeader

1 データ範囲 content-range string

- - -

64 送信するデータの範囲(フォーマットはRFC2616参照)

1 1 ○

64 アップロードID払い出し時にX-kii-ckient-hashに指定した値

0 1 ○5 HTTPHeader

1 クライアントハッシュ if-match string

- - -4 HTTPHeader



- - 1


6 固定値"DOCOMO"1 1 ○ -3 HTTPHeader


X-kii-appkey string

- - 62 HTTPHeader


- - 6

1 1 ○

6 固定値"DOCOMO"1 1 ○

1 URIPath

- アップロードID {upload ID} string


- - 64 64 サーバから払いだされたアップロードID



不可省略時値



5 文字コード

6 備考

3 入力形式4 Content-Type

1 HTTPメソッド PUT

2 リクエストURIhttps://slb.photocolle-docomo.com/app/dcm_slb/api/0.8/Generic2/uploads/{upload ID}/data

概要

GSCT情報のアップロード及びUploadIDの取得で取得したUpload IDを指定し、チャンクをPUTで送信します。チャンクはバイナリ形式で送信します。送信するサイズはcontent-rangeヘッダを使⽤して指定します。






IF_SLB_R1014.0

分割アップロード（分割アップロード）

2.32 - 18

自動選択

自動選択

追加したレコードのデータID1 1 ○1 JSONElement

1 データID id string - - 22 41


不可省略時値






1 出力形式 JSON2 Content-Type application/json



64 アップロードID払い出し時にX-kii-ckient-hashに指定した値

0 1 ○5 HTTPHeader

1 クライアントハッシュ if-match string

- - -4 HTTPHeader



- - 1


6 固定値"DOCOMO"1 1 ○ -3 HTTPHeader


X-kii-appkey string

- - 62 HTTPHeader


- - 6

1 1 ○

6 固定値"DOCOMO"1 1 ○

1 URIPath

- アップロードID {upload ID} string


- - 64 64 サーバから払いだされたアップロードID



不可省略時値



5 文字コード

6 備考



2 リクエストURIhttps://slb.photocolle-docomo.com/app/dcm_slb/api/0.8/Generic2/uploads/{uploadID}/status/committed

概要

チャンクのアップロードで全てのチャンクを送信し終えた後、アップロードの確定を実⾏します。成功するとサーバは追加したレコードのdata-idを応答します。






IF_SLB_R1024.0

分割アップロード（アップロード確定）

2.33 - 19





err_cd string

- - -1 JSONElemen


- - -

- 1：失敗処理結果が正常か失敗かを示す。

1 1 ○ -


不可省略時値





- - 13 JSONElement

1 空き容量 free_space string 13 0 ～ 1072668082176 (999Gbyte) 全サービスでユーザが使用可能な空き容量単位はbyte

アップロード継続可能なエラーの場合は、固定値が設定される。

1 1 ○

13 0 ～ 1072668082176 (999Gbyte) ※PCアプリの時のみ設定される全サービスでユーザが使用可能な最大容量（空き容量ではない）単位はbyte

アップロード継続可能なエラーの場合は、固定値が設定される。

0 1 ○2 JSONElement

1 最大容量 max_space string

- - -1 JSONElemen


- - 1


1 1 ○



不可省略時値



4 備考





項番項目名内容1 出力形式 JSON2 Content-Type application/json

1 HTTPHeader



設定値

- - - -

データ型説明

詳細は「共通規定」を参照1 1 ○ -

最大最小最大項目出現数 null

不可省略時値

数値文字列長リクエスト情報



最小最大最小


1 HTTPメソッド GET

2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/1.0/docomo/capacity

概要

空き容量確認APIを使用して、ストレージの空き容量を取得することが可能となる。






IF_XLB_R0451.0

空き容量確認

3.00 - 20

業務外エラー応答形式

各インタフェースのシートには、インタフェース固有の業務エラー応答について記載しているが、それ以外にも認証エラーといった共通的なエラーが存在する。当該資料では、その共通的エラーについてまとめて記すこととする。

エラー応答パターンの識別

業務エラー以外のエラー応答としては、以下パターンが存在する。

なお、下表の「値あり」項目は、エラーの詳細内訳を識別するための情報が設定されている。

パターン１～７が、どのIFの時に発生しうるかについては、「業務外エラーマッピング」シート参照。（パターン８はどのIFにも発生しうる）返却パラメータ

result err_cd error

SyncLB

エラー応答パターン1

エラー応答パターン2　


パターン番号発生タイミング HTTPステータスHTTPヘッダ

パターンの説明（参考）エラーを返却するプログラムContent-Type oauth_problem errorcode

- - 値あり※OAuth2.0関連のパラメータ不正/認可情報の検証失敗※エラー値については、WWW-Authenticateヘッダにerror={エラーコード}の形式で記載・返却される。

ＡＰＩ運用基盤からのエラー値を連携

2 401 Unauthorized text/plain - -

1

OAuth2.0利用時※アクセストークン発行時については、APＩ運用基盤のＩＦ仕様書を参照

のこと

400 Bad Request text/plain - -

7 200 OK application/json -

- - 値あり※

3

- - - -

- 値あり値あり -

403 Forbidden text/plain - - - -

- -

値あり※

トークン検証時のAPI運用基盤内でのエラー拡張LB

拡張LB

6 503 Service Unavailabletext/plain - - - - - 拡張LB

アカウントステータス不正各ＨＴＴＰステータスコードに対応するユーザの状態は以下の通り　306　：強制利用停止のため利用不可 403　：サービス未登録のため利用不可 503　：一時的に利用停止のため利用不可

拡張LB

5 403 Forbidden text/plain - - -

4 306 text/plain -

- -ＡＰＩ運用基盤との状態不整合エラーもしくは　サーバ内処理エラー

2 Content-Type text/plain

拡張LB

9 400 text/plain - - -

8500 Internal ServerError

text/plain - - -

- -トークン検証エラー分割アップロード利用時のみ発生


ミドルウェアまたはフレームワーク



10 共通上記以外

エラーの意味は、HTTPステータスコードの定義（RFC2616）に従う。※ JSONなどのリクエスト構文不正は 400 Bad Request(Bodyなし）を返却する。

4 備考

・エラー内容等の応答内容については、以下の形式にて、WWW-Authenticateヘッダ中に含まれる形で応答される

WWW-Authenticate:<SP>Bearer<SP>error="xxxxx"<SP>error_description="xxxxxx"

・HTTPレスポンスのbody部には、"Bad Request"という文字列が入る形で応答さ


HTTP ステータス 400 意味認可の失敗備考

項目出現数 null不可

省略時値数値

XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型文字列長

設定値説明最小最大最小最大最小最大

- invalid_request アクセストークンが設定されていない場合。

1 1 -

2 エラー詳細 error_description string

- - -1 エラーコード error string

- - - - ※値はAPI運用基盤で規定エラー発生理由0 1 -

2 Content-Type text/plain3 文字コード UTF-8



4 備考



・HTTPレスポンスのbody部には、"Unauthorized"という文字列が入る形で応答さ




省略時値数値

XML ROOT ELEMENT



- invalid_token リクエストされたアクセストークンが無効な場合。または、リクエストされたアクセストークンが有効期限切れの場合。

1 1 -







4 備考



・HTTPレスポンスのbody部には、"Forbidden"という文字列が入る形で応答され




省略時値数値



- insufficient_scope APIの呼び出しに必要なスコープが認可されていない場合。

1 1 -




エラー応答形式 - 21










4 備考・HTTPレスポンスのbody部には、半角スペースが入る形で応答される。


HTTP ステータス 306 意味当該アカウントが強制利用停止状態のため利用不可

備考

1



不可省略時値

数値







HTTP ステータス 403 意味当該アカウントがサービス未登録のため利用不可

備考

1 HTTPBody



不可省略時値

数値







HTTP ステータス 503 意味当該アカウントが一時的に利用停止のため利用不可

備考

1



不可省略時値

数値




4 備考


HTTP ステータス 200 意味トークン検証時のAPI運用基盤内でのエラー

備考


省略時値数値



- 11 1 ○ -

2 JSONElement

1 エラーコード err_cd int

- - -1 JSONElement


- - - - 以下のいずれか 900 :内部処理エラー 901 :タイムアウト 902 :パラメータエラー

1 1 ○ -





4 備考・HTTPレスポンスのbody部には、"Internal Server Error"という文字列が入る形で応答される。


HTTP ステータス 500 意味

ＡＰＩ運用基盤との状態不整合エラーもしくは　サーバ内処理エラー

備考

1



不可省略時値

数値







4 備考


HTTP ステータス 400 意味トークンチェック時のエラー備考分割アップロード利用時のみ発生する

1 HTTPBody

1 string



不可省略時値

数値

- - Cant get valid address from accesstoken.

1 1 ○


業務外エラーマッピング

エラー応答パターン番号

物理項目名

項目値

1003 1004 1005 9001

version_rejected

parameter_absent

parameter_rejected

timestamp_refused

signature_method_rejected

nonce_used

signature_invalid

consumer_key_unknown

token_expired

token_rejected

verifier_invalid

permission_unknown

permission_denied

parameter_absent

parameter_rejected

token_expired

token_rejected

permission_denied

invalid_request

invalid_token

insufficient_scope

306

403

503

900

901

902

500

400

インタフェースID インタフェースバージョン

IF_XLB_R090 2.0 コンテンツIDリスト取得 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R080 2.0 コンテンツ削除履歴取得 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R076 2.0 コンテンツ情報取得(原本・リサイズ) ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R077 2.0 コンテンツ情報取得(サムネイル) ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R046 1.0 アップロード ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R045 1.0 空き容量確認 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R174 4.0 回転情報編集 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R175 4.0 コンテンツ削除 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R177 4.0 アップロード（タグ付き） ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R222 4.0 コンテンツ情報取得(サムネイル複数) ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － ○ －－－－－－ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ －

IF_XLB_R100 4.0 分割アップロード（UploadIDの取得）－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ ○ ○

IF_XLB_R101 4.0 分割アップロード（分割アップロード）－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ ○ ○

IF_XLB_R102 4.0 分割アップロード（アップロード確定）－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ ○ ○

インタフェース名

12errorcode oauth_problem oauth_problem error (HTTPステータスコード) err_cd (HTTPステータスコード)

1 2,3 4 5・6・7 8.9.10 11

業務外エラーマッピング - 24

業務エラーマッピング

406 409

インターフェースIDインターフェース

バージョンインターフェース名称

エラーコードステータスコード

備考

100 101 102 103 900 1101 1102 1103104 109 110 112 113 114 415 416 420###116 150

○ - - -- - ○ - ○ -

1105 ### ### ### ### ###

- - -- - - - - -- - - - - -

### ### 404

- -

IF_XLB_R080 2.0 コンテンツ削除履歴取得 ○ - - -

IF_XLB_R090 2.0 コンテンツIDリスト取得 ○ - - -

○ - - -- - ○ - - - - - -

IF_XLB_R076 2.0 コンテンツ情報取得(原本・リサイズ) ○ ○ - -

- - - - - -- - - - - -- -

○ - - -- - ○ - - - - - -

IF_XLB_R077 2.0 コンテンツ情報取得(サムネイル) ○ ○ - -

- - - - - -- - - - - -- -

○ - - -- - ○ - - - - - -

IF_XLB_R046 1.0 アップロード - - - -

- - - - - -- - - - - -- -

- ○ ○ -- - - - - - - - -

IF_XLB_R045 1.0 空き容量確認 - - - -

- - - - - -- ○ ○ ○ ○ -- -

- - - ○- - - - - - - - -- - - - - -- - - - - -- -

IF_XLB_R174 4.0 回転情報編集 ○ ○ - -- - - ○ - -- - ○ ○ - -

- ○ -

- - -

- - -

-

IF_XLB_R175 4.0 コンテンツ削除 ○ ○

- - - - - -- - - - -

- -- - -

IF_XLB_R177 4.0 アップロード（タグ付き） ○ - ○

- - -- - - - - -- - - ○ ○ -- - -

-- - - ○ - -- ○ - ○ - -

- ○ -

- - - -

IF_XLB_R222 4.0 コンテンツ情報取得(サムネイル複数) ○ ○

- - - - - -- - - - -

- -- - - - - -

IF_SLB_R100 4.0 分割アップロード（UploadIDの取得） - - -

- - -- - - - - -- - - - ○ -- - -

-

IF_SLB_R101 4.0 分割アップロード（分割アップロード） - -

- - - - - -- - - - - -- - - - -

- - - - - -

- ○ --- - - - - -

- - - - - -- - - - - - - ○ - ○ -- - - - - ○

- - - - - - - - - ○ - - ○- - - - ○ ○IF_SLB_R102 4.0 分割アップロード（アップロード確定） - - - - - -- - - - - -

業務エラーマッピング - 25

エラーコード一覧

備考

1 100 200

パラメータエラー必須、桁数、文字種別、範囲等の形式チェックエラー※禁則文字チェックは実施しない。

×

No エラーコード HTTPステータスコード概要説明リトライ可否

3 102 200

名称重複（タグ）重複不可のパラメータの名称重複※同一のタグIDを指定して同一のタグ名を追加する場合はエラーは発生しないが、新規追加で同一のタグ名を追加する場合にはエラーが発生する。

×

2 101 200

該当情報なし取得、更新、削除対象なし。(ファイル、タグ等が存在しない)

×

5 104 200

容量超過保存できる容量を超過、コンテンツの最大サイズを超過

×

4 103 200

登録最大数超過（タグ）

登録できる最大数を超過

×

7 110 200

タイムアウト処理が規定の時間で終わらない

○

6 109 200

状態不整合許可されない状態で操作を行った(タグソート/タグ一括登録時のタグ情報不一致等)

×

9 150 200

リクエスト上限数超過

リクエスト時に指定できる上限数を超過

×

8 113 200

検索結果が0件参照インタフェースでの結果が0件（0件を許容していない場合）

×

11 1101 200

コンテンツ重複コンテンツが重複している

×

10 900 200

内部処理エラーサーバ内で内部処理エラーが発生

×

13 1103 200

（内部処理エラー）空き容量取得エラー

空き容量が取得できない

×

12 1102 200

（容量超過）指定容量超過

ユーザごとの指定容量を超えている

×

15 1110 200

（パラメータエラー）必須項目不足

必須項目が不足している

×

14 1105 200

該当情報なしコンテンツが存在しない

×

17 1112 200

（パラメータエラー）項目型不正

項目の型が不正である

×

16 1111 200

（パラメータエラー）項目サイズ不正

項目のサイズが不正である

×

19 1114 200

（パラメータエラー）汎用パラメータエラー

パラメータが不正である

×

18 1113 200

（パラメータエラー）項目値不正

項目の値が不正である

×

21 1122 200

検索結果が0件参照系の取扱において、参照結果が0件

＊0件を許容していない場合に設定される。×

20 1121 200

タイムアウト処理が時間内に終了しない場合

○

23 - 404該当情報なしアップロードIDが存在しない

×

22 9000 200

内部処理エラーサーバ内で内部処理エラー（不整合等）が発生した場合

×

25 - 409

パラメータエラー（分割アップロード(分割アップロード)）if-matchの値が不一致（分割アップロード(アップロード確定)）Uniquekeyが重複している

×

24 - 406 アップロード確認エラー

データが最後までアップロードされていない ×

28 - 420

容量超過保存できる容量を超過、コンテンツの最大サイズを超過

×

27 - 416（パラメータエラー）項目値不正

Content-rangeの値が不正である×

26 - 415（パラメータエラー）項目値不正

Content-Typeの値が不正である×

エラーコード一覧 - 26

メタ情報

分割アップロード（UPLOAD ID取得）で利用するメタ情報以下の項目をUTF-8、JSON形式で作成する。

（JSON形式例）

1 Typeファイルの種別

String 1 11画像⇒Image動画⇒Video

2 Title ファイルの名称 String 1 255255byte以内の文字列

3 Sizeファイルのサイズ(byte)

Long 1 9 1～100M(動画MAX時のサイズ)

4 CreationTime情報が作成された日時

Long 1 10UnixTime(端末で撮影日を設定する。撮影日が取得できない場合は、ファイル作成日を設定

5 UpdateTime

情報が更新された日時(タグ編集などの更新も含む)

Long 1 10

UnixTime

6 MimeType MIMEタイプ String 1 15

【画像コンテンツ】image/jpeg　JPEG画像【動画コンテンツ】video/3gpp　3GP動画(.3gp)video/avi AVI動画(.avi)video/quicktime　(.mov)video/mp4(.mp4)video/vnd.mts　(.mts)video/mpeg　(m2ts)

7 UniqueKey重複チェックで使用するためのユニークキー

String 1 300

300byte以内の文字列(ファイル名+撮影日+ファイルサイズを"_"区切りで結合したもの)exifで撮影日が取得できないものは、撮影日部分は0パディングとする。(撮影日部のフォーマットはyyyymmddhhmmsssssとする。）※同一の値を持つレコードが存在した場合は重複エラーが発生する

[例]Image001.jpg_20120201102233444_1024

8 VirtualRoot“docomo“固定の値を常に指定。

String 1 6“docomo“固定

{ "CreationTime":"1362025565", "UpdateTime":"1362025565", "MimeType":"image/jpeg" , "Type": "Image" , "Title":"20130228_132605.jpg" , "UniqueKey":"20130228_132605.jpg_20130228132605000_1328421" , "VirtualRoot":"docomo" , "Size":"1328421" }

プロパティ

No. 項目 Property 説明フィールド型送信個数

最大長(byte)

備考

ユニークキー

仮想ルート

ファイルタイプ

ファイル名

サイズ

情報作成日時

情報更新日時

MIMEタイプ

Documents

ドコモクラウドAPI技術資料 · if_xlb_r174 回転情報編集 4.0 画像の回転情報の編集を行う if_xlb_r175 コンテンツ削除 4.0 コンテンツの削除を行う