Comments
Description
Transcript
仕様書
2015 NTT DOCOMO, INC. All Rights Reserved. 【フォトコレクションAPI】 ドコモクラウドAPI技術資料 第1.35版 2015年9月16日 株式会社NTTドコモ 変更履歴 版数 1.1 1.2 1.3 変更日 2013/07/22 変更箇所 ・リクエスト情報 項番2 「プロジェクション」の説明を 変更 変更前：「（無視される）」 変更後：取り消し 2.06, 3.00 IF_XLB_R046 アップロード IF_XLB_R045 空き容量確認 レスポンス項目の「処理結果」と「エラーステータス コード」の「データ型」を「int」から「string」に変更 2013/11/14 2.06 2013/12/17 2.20, 2.21, 2.22, 2.23 IF_XLB_R174 回転情報編集 IF_XLB_R175 ゴミ箱移動、復元 IF_XLB_R176 コンテンツ削除 IF_XLB_R177 アップロード（タグ付き） 2.03 リクエスト情報ファイルの説明覧に以下を追記 「拡張子を含んだ文字列、Content-Dispositionに filenameが必要」 左記IFを追加 削除履歴取得期限として14日間を追記 2.31～２.33 IF_SLB_R100 分割アップロード（UploadIDの取得） IF_SLB_R101 分割アップロード（分割アップロード） IF_SLB_R102 分割アップロード（アップロード確定） IF_XLB_R222 コンテンツ情報取得（サムネイル複数） 1.31 1.32 1.33 1.34 1.35 変更内容 2.01 IF_XLB_R074 コンテンツIDリスト取得（タグ詳細付） 2.24~2.29 2014/01/29 2.01,2.03 2014/02/13 2.31～２.33 2014/03/06 別紙1 2015/08/06 別紙1「１．場所タグマスタ」 2015/09/02 共通規定 左記IFを追加 文言の修正 文言の修正 全体レイアウトを調整 「２．状態に対応する内容」を追記 対応国を追記 TLSバージョンを1.0~1.2に変更 許容Suiteを追記。 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030) MIME TYPEにimage/png,video/x-m4vを追加 2.04 2.06 2.23 メタ情報 変更履歴 - 2 INDEX ■ フォトコレクションが提供するAPI IFID インタフェース名称 IFバー ジョン 概要 コンテンツとメタデータの操作 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 IF_XLB_R174 IF_XLB_R175 アップロード 回転情報編集 ゴミ箱移動、復元 1.0 4.0 4.0 IF_XLB_R176 IF_XLB_R177 IF_XLB_R222 IF_SLB_R100 IF_SLB_R101 IF_SLB_R102 共通機能 IF_XLB_R045 コンテンツ削除 アップロード（タグ付き） コンテンツ情報取得(サムネイル複数) 分割アップロード（UploadIDの取得） 分割アップロード（分割アップロード） 分割アップロード（アップロード確定） 4.0 4.0 4.0 4.0 4.0 4.0 原本データの登録ができる。 た画像の回転情報の編集を行う コンテンツのゴミ箱移動（一時削除）およびゴミ箱からの復元 （一時削除取り消し）を行う ゴミ箱内コンテンツを完全削除する。 コンテンツ(原本)を登録する。 コンテンツのサムネイル画像を取得する。 分割アップロードのためのUPLOADIDを取得する 画像を分割アップロードする 分割アップロードの確定をする 空き容量確認 1.0 ストレージの空き容量を取得することができる。 ※上記APIの他、「タグ情報（グループ情報）を取得する」APIも提供しております。 興味をお持ち頂いた方は、photo‐colle‐[email protected] までご連絡をお願いいたします。 後日、担当者より、ご連絡をさせて頂きます。 INDEX - 3 共通規定 1. プロトコル 各IFに特別な記述が無い限り、下記のプロトコルのRFCに従って作成すること HTTP over TLS プロトコル ： 1.1 HTTPバージョン ： 1.0~1.2 TLSバージョン ： TLS_ RSA_WITH_AES_256_CBC_SHA TLS暗号スイート ： 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 5. 日付・時刻のフォーマット (1) 日付・時刻のフォーマットは RFC 3339 に従い、string型で表現する。 (2) サーバが設定する日時・時刻項目の time-offset は、個別に記載がない限り、"+09:00" とする。 (3) リクエストパラメータの日時・時刻項目の time-offset は、個別に記載がない限り、任意とする。 参考： RFC 3339 における日付・時刻フォーマットのABNF date-fullyear date-month date-mday time-hour time-minute time-second time-secfrac time-numoffset time-offset = = = = = = = = = 4DIGIT 2DIGIT ; 01-12 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on month/year 2DIGIT ; 00-23 2DIGIT ; 00-59 2DIGIT ; 00-58, 00-59, 00-60 based on leap second rules "." 1*DIGIT ("+" / "-") time-hour ":" time-minute "Z" / time-numoffset partial-time full-date full-time = time-hour ":" time-minute ":" time-second [time-secfrac] = date-fullyear "-" date-month "-" date-mday = 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ビット符号付整数 (-263 ～ +(263-1)) array 配列 object オブジェクト null 項目出現数 （最小/最大） 項目出現数=0は、値だけでなく項目名も省略することを表す。 XMLスキーマにおける minOccurs, maxOccurs に相当。 「階層」≧2の場合は、ひとつ上の「階層」の項目1件に対しての当該項目の出現 数とする。（つまり、ひとつ上の階層が項目出現数=0を許容するか否かには依存 しない） null不可 ○は、項目が出現した場合で値に null を許容しないことを表す。 nullの定義は以下の通りである。 URI Path null は、空文字列（文字列長=0）と同義とする。 ※Path上のパラメータ位置は固定なので、項目出 現数を1と見なし、本基準を適用する URI Query HTTP Header Cookie Form "key=" のように、項目名あり＋値指定なしの値を null と定義する。 ・文字列項目の場合、null は空文字列 （文字列長=0）と同義である ∴ 文字列長≧1 ⇒ NULL不可， 文字列長≧0 ⇒ NULL可 となる ・数値項目の場合、null と 0 とは区別される JSON Element null値 は 「null」 （ダブルクォートで囲まない）と表記 される(RFC 4627通り)。 （例） "key" : null XML Element XML Attribute 本システムでは null を許容しない（必ずnull不可）。 →「値なし」を表現したい場合は、要素そのものを 省略(項目出現数=0)すること （以下参考） XML要素における null の定義。 nil属性に"true"が設定された要素の値を null とす る。前提として、XMLスキーマを用意し、その要素 定義において nillable="true" が設定されているこ と。 （例） <key xsi:nil="true"></key> 省略時値 項目が省略（項目出現数=0）された場合、または null値 が指定された場合に適 用されるデフォルト値。 数値 （最小/最大） 文字列長 （最小/最大） 設定値 説明 データ型が number, int, long の場合、当パラメータの（IF仕様として規定する）最 小/最大値と不等号（＞/≧/≦/＜）。 データ型が string の場合に、当パラメータの（IF仕様として規定する）文字数の最 小/最大値。 項目書式や取りうる値の詳細など。 項目の意味、用途などの説明。 凡例 - 6 インタフェース バージョン インタフェースID /インタフェース名称 IF_XLB_R090 インタフェース仕様書 2.0 コンテンツIDリスト取得 概要 コンテンツのメタデータを検索し返却する。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolledocomo.com/file_a2/2.0/ext/file_search/get_list 3 4 5 入力形式 Content-Type 文字コード 6 備考 # JSON application/json UTF-8 ・各（フィルタ条件）項目は、全てAND条件として検索に適用される。 ・省略可能な（フィルタ条件）項目の指定を省略すると、当該フィルタは適用 されない（ただし省略時値が定義されている場合は省略時値が適用される）。 ・（ページング条件）の説明は「共通規定」を参照のこと。 リクエスト情報 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 プロジェクション projection string 1 1 ○ 3 JSON Element 1 画像種別コード file_type_cd int 1 4 JSON Element 1 ごみ箱指定 dustbox_condition int 5 JSON Element 1 アップロード日時 （最小値） min_date_upload 6 JSON Element 1 7 JSON Element 8 9 数値 文字列長 最小 最大 - 設定値 説明 最小 - 最大 - - - - 1 ○ - - - - - 以下のいずれか 1:静止画，2:動画，3スライドムービー （フィルタ条件） コンテンツのメディア種別 0 1 ○ - - - - - 以下のいずれか 1 : ごみ箱以外のコンテンツ 2 : ごみ箱内のコンテンツ （フィルタ条件） コンテンツがゴミ箱内にあるか否 か string 0 1 ○ - - - 20 25 RFC 3339 の date-time フォーマットで 秒の1の位まで指定 タイムゾーンは任意に設定してよい yyyy-mm-ddThh:mi:ss+09:00 (JSTの 例) yyyy-mm-ddThh:mi:ssZ (UTCの例) （フィルタ条件） コンテンツのアップロード日時が 本項目値以上のもの ※「更新日時（最小値）」と同時に 指定することは認めない 更新日時（最小値） min_date_modified string 0 1 ○ - - 20 25 RFC 3339 の date-time フォーマットで 秒の1の位まで指定 タイムゾーンは任意に設定してよい yyyy-mm-ddThh:mi:ss+09:00 (JSTの 例) yyyy-mm-ddThh:mi:ssZ (UTCの例) （フィルタ条件） コンテンツの更新日時が本項目 値以上のもの ※「アップロード日時（最小値）」と 同時に指定することは認めない 1 最大返却件数 max_results int 0 1 ○ 100 ≧1 JSON Element 1 開始番号 start int 0 1 ○ JSON Element 1 ソート指定 sort_type int 1 1 ○ RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 - 1 詳細は「共通規定」 2を参照 1 固定値 3 : 詳細情報（タグ情報無） 返却データ項目セットの範囲 ≦100 - - （ページング条件） 検索結果全体のうち、レスポンス として返却する最大件数（ページ サイズ） ※内部的には上限値と省略時値 は、それぞれプロパティで定義す る可変値とする 1 ≧1 - - - （ページング条件） 検索結果全体のうち、レスポンス として返却するレコードの開始番 号。 ※検索結果の総件数を上回る値 が指定された場合は、「コンテンツ 数=0」で正常応答する - - - - 最大 - 文字列長 最小 最大 0 ： 成功 - 以下のいずれか 1：撮影日の降順 2：撮影日の昇順 3：更新日時の降順 4：更新日時の昇順 5：アップロード日時の昇順 6：アップロード日時の降順 （ページング条件） 検索結果（コンテンツリスト）の ソート条件。 内容 JSON application/json UTF-8 レスポンス情報 HTTP ステータス 200 意味 正常 備考 XML ROOT ELEMENT 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 数値 項番 種別 階層 1 JSON Element JSON Element 1 処理結果 result int 1 コンテンツ数 content_cnt int 1 1 ○ - ≧0 - - - 3 JSON Element 1 開始番号 start int 1 1 ○ - ≧1 - - - リクエストの開始番号と同じ値 4 JSON Element 1 次ページ開始番号 next_page int 1 1 ○ - ≧0 - - - ・次ページありの場合 開始番号 + コンテンツ数 ・次ページなしの場合 0 5 JSON Element 1 コンテンツリスト content_list array 1 1 ○ - - - - 2 論理項目名 物理項目名 データ型 - 最小 - 設定値 説明 処理結果が正常か失敗かを示 す。 本レスポンスの返却コンテンツ数 （コンテンツリストの要素数） 検索結果全体のうち、レスポンス として返却するレコードの開始番 号。 検索条件を満たすコンテンツのリ スト ※検索結果の「コンテンツ情報」 件数=0の場合は、空（要素数=0） の array とする。 "content_list" : [ ] 6 2 コンテンツ情報 content_info object 0 100 ○ - - - 7 JSON Element JSON Element 8 JSON Element 9 JSON Element 10 JSON Element 3 コンテンツID content_guid string 1 1 ○ - - - 1 50 3 string 1 1 ○ - - - 1 255 3 コンテンツファイル content_name 名 画像種別コード file_type_cd int 1 1 ○ - - - 3 撮影日（作成日） string 1 1 ○ - - exif_camera_day - 2.00 - 7 - - - 25 1:静止画，2:動画，3:スライドムービー 25 RFC 3339 の date-time フォーマットで 秒の1の位まで指定 yyyy-mm-ddThh:mi:ss+09:00 コンテンツのメディア種別 EXIFから取得した撮影日。ない場 合はファイル作成日。 11 JSON Element 3 更新日時 mdate string 1 1 ○ - - - 25 25 RFC 3339 の date-time フォーマットで 秒の1の位まで指定 yyyy-mm-ddThh:mi:ss+09:00 コンテンツ情報の最終更新日時。 アップロード後に画像回転等の操 作を行うと更新される。 ゴミ箱内のコンテンツの場合は削 除日時である。 12 JSON Element 3 アップロード日時 upload_datetime string 1 1 ○ - - - 25 25 RFC 3339 の date-time フォーマットで 秒の1の位まで指定 yyyy-mm-ddThh:mi:ss+09:00 ・画像種別コード=1,2の場合 フォトコレクションにコンテンツを アップロード後、分析が完了した 日時 ・画像種別コード=3の場合 スライドムービーの作成日時 13 JSON Element 3 ファイルサイズ file_data_size long 1 1 ○ - 0 - - - 14 JSON Element 3 リサイズNGフラグ resize_ng_flg string 1 1 ○ - - - - - 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 - 原本のファイルサイズ(単位は byte) ※（参考）サービス仕様上の最大 サイズは30MB 0:リサイズOK 1:リサイズNG レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 階層 JSON Element JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード エラー項目 err_cd int 1 1 ○ - - - 1 param_name string 0 1 ○ - - - JSON Element 1 エラー項目値 param_value string 0 1 ○ - - - 3 4 物理項目名 データ型 数値 種別 1 2 論理項目名 null 項目出現数 省略時値 最小 最大 不可 1 1 ○ - 項番 2.00 - 8 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 1 64 エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 300 エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R080 インタフェース仕様書 2.0 コンテンツ削除履歴取得 概要 削除されたコンテンツの情報を取得する。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolledocomo.com/file_a2/2.0/ext/content/get_delete_history 3 4 5 入力形式 Content-Type 文字コード 6 備考 # JSON application/json UTF-8 ・各（フィルタ条件）項目は、全てAND条件として検索に適用される。 ・省略可能な（フィルタ条件）項目の指定を省略すると、当該フィルタは適用 されない（ただし省略時値が定義されている場合は省略時値が適用される）。 ・（ページング条件）の説明は「共通規定」を参照のこと。 自動選択 リクエスト情報 論理項目名 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 画像種別コード int 1 3 JSON Element 1 削除日時（最小日） min_date_deleted string 4 JSON Element 1 最大返却件数 max_results 5 JSON Element 1 開始番号 start RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 file_type_cd データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 文字列長 最小 最大 - 最小 - 最大 - 1 ○ - 1 1 1 0 1 ○ - - - 20 int 0 1 ○ 100 ≧1 int 0 1 ○ 1 ≧1 設定値 説明 OAuth1.0aの場合 詳細は「共通規定」 2-(1)を参照 OAuth2.0の場合 詳細は「共通規定」 2-(2)を参照 1 以下のいずれか 1:静止画，2:動画，3スライドムービー （フィルタ条件） コンテンツのメディア種別 25 RFC 3339の date-time フォーマット （フィルタ条件） タイムゾーンは任意に設定してよい コンテンツの削除日時が本項目 yyyy-mm-ddThh:mi:ss+09:00 (JSTの例) 値以上のもの yyyy-mm-ddThh:mi:ssZ (UTCの例） ≦100 - - （ページング条件） 検索結果全体のうち、レスポンス として返却する最大件数（ページ サイズ） ※内部的には上限値と省略時値 は、それぞれプロパティで定義す る可変値とする - - - （ページング条件） 検索結果全体のうち、レスポンス として返却するレコードの開始番 号。 ※検索結果の総件数を上回る値 が指定された場合は、「コンテン ツ数=0」で正常応答する 内容 JSON application/json 自動選択 UTF-8 レスポンスは取得した項目の登録日の昇順（古いものから）でソートし、返却す レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 数値 文字列長 最小 最大 0 ： 成功 項番 種別 階層 1 JSON Element 1 処理結果 result int 2 JSON Element 1 コンテンツ数 content_cnt int 1 1 ○ - ≧0 ≦100 - - 3 JSON Element 1 開始番号 start int 0 1 ○ - ≧1 - - - リクエストの開始番号と同じ値 4 JSON Element 1 次ページ開始番号 next_page int 0 1 ○ - ≧0 - - - ・次ページありの場合 開始番号 + コンテンツ数 ・次ページなしの場合 0 5 JSON Element 1 コンテンツリスト content_list array 1 1 ○ - - - - - 6 JSON Element 2 コンテンツGUID content_guid string 0 - - 100 ○ - 最小 - 最大 - 1 設定値 説明 処理結果が正常か失敗かを示 す。 本レスポンスの返却コンテンツ数 （コンテンツリストの要素数） 検索結果全体のうち、レスポンス として返却するレコードの開始番 号。 削除済みコンテンツのリスト 50 レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 種別 階層 1 JSON Element JSON Element JSON Element 1 処理結果 result 1 エラーステータス コード エラー項目 err_cd int 1 1 param_name string 0 JSON Element 1 エラー項目値 param_value string 0 2 3 4 論理項目名 物理項目名 データ型 int 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 1 ○ - - - - 1 ○ - - - 1 ○ - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 2.03 - 9 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 1 64 エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 300 エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R076 インタフェース仕様書 2.0 コンテンツ情報取得(原本・リサイズ) 概要 コンテンツ（原本・リサイズ）の画像データを取得する。 項番 REST リクエスト 基本情報 項目名 1 HTTPメソッド 2 リクエストURI 3 4 5 6 入力形式 Content-Type 文字コード 備考 内容 POST https://xlb.photocolle-docomo.com/file_a2/2.0/ext/content/get # JSON application/json UTF-8 リクエスト情報 論理項目名 最小 - 最大 - 文字列長 最小 最大 - - - - - 1 ○ - - - 1 ○ - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 画像種別コード file_type_cd int 1 1 ○ 3 JSON Element 1 コンテンツID content_guid string 1 4 JSON Element 1 ファイル種別 resize_type_cd int 1 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 データ型 項番 数値 - 1 説明 詳細は「共通規定」 2を参照 以下のいずれか 1 : 静止画、2 : 動画、3 : アルバム 50 - - 設定値 取得対象画像のファイルID 以下のいずれか 画像種別コードが1、3の場合は 1 : 原本、2 : リサイズ画像、 3 : リサイズ 1,2を指定。2の場合は1.2.3を指 動画 定。 内容 UTF-8 1. リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。 2. リサイズ画像のEXIFは、Orientation以外は原本と同じ内容である。 3. リサイズ画像は、原本画像を原本のEXIF-Orientationで補正した向きに回転 加工されている。これに伴いリサイズ画像のEXIF-Orientation=1固定となって いる。 4. フォトコレクションの画面上でユーザが画像を回転させた結果は 「IF_XLB_R074 コンテンツIDリスト取得（タグ詳細付）」レスポンスの「回転 情報」に反映される。 この「回転情報」はリサイズ画像（上記3）に対する補正角度である。 原本画像の向きを補正するためには、「回転情報」に加えて原本のEXIFOrientationを反映する必要がある。 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 1 HTTP Header 階層 Content-Type 論理項目名 Content-Type 物理項目名 string データ型 2 HTTP Body コンテンツ - OutputStr eam 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 1 1 ○ - 数値 文字列長 設定値 最小 最大 以下のいずれか image/jpeg image/pjpeg image/png video/3gpp video/avi video/quicktime video/mp4 video/vnd.mts video/mpeg video/x-m4v 最小 - 最大 - - - - 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 - - 説明 コンテンツのバイナリデータ レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 階層 JSON Element JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード エラー項目 err_cd int 1 1 ○ - - - 1 param_name string 0 1 ○ - - - JSON Element 1 エラー項目値 param_value string 0 1 ○ - - - 3 4 物理項目名 データ型 数値 種別 1 2 論理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 2.04 - 10 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 1 64 エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 300 エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R077 インタフェース仕様書 2.0 コンテンツ情報取得(サムネイル) 概要 コンテンツのサムネイル画像を取得する。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/2.0/ext/thumbnail/get 3 4 5 6 入力形式 Content-Type 文字コード 備考 JSON application/json UTF-8 # リクエスト情報 論理項目名 種別 階層 1 HTTP Header - OAuth認証スキーム Authorizationヘッダ Authorization string 2 JSON Element 1 コンテンツIDリスト content_info_list array 1 1 ○ 3 JSON Element 2 コンテンツID content_guid string 1 30 ○ RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 - - - - - - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 設定値 説明 詳細は「共通規定」 2を参照 - 1 50 内容 JSON application/json UTF-8 リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 論理項目名 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 1 1 0 ： 成功 - - - - 30 ○ - - - - 1 ○ - - - 1 1 1 ○ - - - 1- 1 1 ○ - - - 1- 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 種別 階層 1 JSON Element 1 処理結果 result int 2 JSON Element 1 コンテンツ情報リスト content_info_list array 1 1 ○ 3 JSON Element 2 コンテンツ情報 content_info object 1 4 JSON Element 3 コンテンツID content_guid string 1 5 JSON Element 3 MIMEタイプ mime_type string 6 JSON Element 3 サムネイル画像 thumbnail string 数値 設定値 説明 処理結果が正常か失敗かを示 す。 - 50 リクエストのコンテンツIDと同じ image/jpeg 画像のメディアタイプ Base64エンコードされたサムネイ ルの画像データ。 レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 種別 階層 1 JSON Element JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード エラー項目 err_cd int 1 1 ○ 1 param_name string 0 1 ○ JSON Element 1 エラー項目値 param_value string 0 1 ○ 2 3 4 論理項目名 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 - - - - - - - - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 2.05 - 11 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 1 64 エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 300 エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R046 インタフェース仕様書 1.0 アップロード 概要 コンテンツ書き込みAPIを使用して原本データの登録が可能となる。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/1.0/docomo/create 3 4 5 6 入力形式 Content-Type 文字コード 備考 MULTIPART multipart/form-data UTF-8 チャンク取得（Rangeリクエスト）は使用できない。 # リクエスト情報 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 種別 階層 1 HTTP Header - OAuth認証スキーム Authorizationヘッダ Authorization string 2 Form 1 ファイルタイプ type string 1 1 ○ 3 Form 1 ファイル名 title string 1 4 Form 1 サイズ size string 5 Form 1 MIMEタイプ mime_type string 数値 文字列長 最小 最大 - 最小 - 最大 - - - - 1 11 1 ○ - - - 1 255 1 1 ○ - - - 1 9 1 1 ○ - - - 1 15 設定値 説明 詳細は「共通規定」 2を参照 Image：画像の場合 Video：動画の場合 画像や動画を設定する。 拡張子を含んだ文字列 ファイルのサイズ(byte)を設定す る。 画像の場合、1～30MBを設定す る。 動画の場合、1～100MBを設定す る。 画像の場合 image/jpeg：JPEG画像 image/pjpeg：PJPEG画像 image/png：PNG画像 MIMEタイプを設定する。 動画の場合 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) 6 Form 1 本文 file RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 InputStre am 1 1 ○ - - - - 画像・動画データを設定する。 画像の場合、最大30MBとなる。 動画の場合、最大100MBとなる。 拡張子を含んだ文字列、 Content-Dispositionにfilenameが 必要 最小 - 最大 - 文字列長 最小 最大 1 1 0 ： 成功 - - - 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element JSON Element 1 処理結果 result string 1 ファイルID data_id string 2 論理項目名 物理項目名 データ型 null 項目出現数 省略時値 最小 最大 不可 1 1 ○ 1 1 ○ - 数値 設定値 説明 処理結果が正常か失敗かを示 す。 41 アップロードされたコンテンツのファイル コンテンツに対してサーバ側で採 IDが設定される。 番された一意の値 41 レスポンス情報 200 HTTP ステータス 意味 処理失敗 備考 XML ROOT ELEMENT 物理項目名 最小 - 最大 - 文字列長 最小 最大 1：失敗 - - - - - 1 ○ - - - - - 1 1 ○ - - - 1 string 0 1 ○ - - - 41 string 0 1 ○ - - - 1 種別 階層 1 JSON Element JSON Element 1 処理結果 result string 1 エラーリスト err_list array 1 1 ○ 3 JSON Element 1 エラーステータス コード err_cd string 1 4 JSON Element 1 エラー項目 err_item string 5 JSON Element 1 ファイルID data_id 6 JSON Element 1 状態 status 2 論理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 データ型 数値 設定値 説明 処理結果が正常か失敗かを示 す。 エラーが発生した場合に配列形 式で設定される。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 エラーが発生したリクエストの項 255 目名が設定される。 41 【PCアプリのみ】 エラーステータスコードが「1101」 の場合は、重複したファイルIDを 設定する。 1 別紙１の「２．状態に対応する内容」を参 【PCアプリのみ】 照 コンテンツの状態が設定される。 エラーステータスコードが「1101」 の場合、必須となる。 2.06 - 12 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R174 インタフェース仕様書 4.0 回転情報編集 概要 指定されたコンテンツに対し、回転情報の編集を行う。 ゴミ箱に入っているコンテンツに対しては、回転情報の編集は行えない。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/dtl/set_rotate 3 4 5 6 入力形式 Content-Type 文字コード 備考 JSON application/json UTF-8 リクエスト情報 論理項目名 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 コンテンツID content_guid string 1 1 ○ 3 JSON Element 1 画像の向き orientation int 1 1 ○ RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 文字列長 最小 最大 - 設定値 最小 - 最大 - - - - - - - - 最大 - 文字列長 最小 最大 0 ： 成功 最小 - 最大 - 文字列長 最小 最大 1：失敗 - 35 50 - 説明 詳細は「共通規定」 2を参照 回転情報の変更を行うコンテンツ のコンテンツIDを指定する 0：回転しない 90：右90度回転 180：上下反転 270：右270度回転(左90度回転) ・画像の向きを示す値を設定する 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 論理項目名 処理結果 物理項目名 result データ型 int 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 数値 最小 - 設定値 説明 処理結果を下記の値で表す。 0 ： 成功 1 ： 失敗 レスポンス情報 HTTP ステータス 200 意味 異常 備考 XML ROOT ELEMENT 階層 JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード err_cd int 1 1 ○ - - - 3 4 5 JSON Element JSON Element JSON Element 物理項目名 データ型 数値 種別 1 2 論理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 - 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 1 コンテンツID content_guid string 0 1 ○ - - - 1n コンテンツID 1 エラー項目 param_name string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 エラー項目値 param_value string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 2.20 - 13 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R175 インタフェース仕様書 4.0 ゴミ箱移動、復元 概要 コンテンツのゴミ箱移動（一時削除）および、ゴミ箱からの復元（一時削除取り消し）を行う。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/dtl/set_trash 3 4 5 6 入力形式 Content-Type 文字コード 備考 JSON application/json UTF-8 リクエスト情報 論理項目名 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 - - - - - - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 コンテンツIDリスト content_guid_list array 1 1 ○ 3 JSON Element 2 コンテンツID content_guid string 1 100 ○ 数値 設定値 説明 詳細は「共通規定」 2を参照 - 50 35 ・ゴミ箱移動、復元を行うコンテン ツのコンテンツIDを指定する。 ※内部的には上限値はプロパ ティで定義する可変値とする 4 JSON Element 1 ステータス RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 status int 1 1 ○ - - - - - 0：復元 1：ゴミ箱移動 最大 - 文字列長 最小 最大 0 ： 成功 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 論理項目名 処理結果 物理項目名 result データ型 int 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 数値 最小 - 設定値 説明 処理結果を下記の値で表す。 0 ： 成功 1 ： 失敗 ※1ファイルでも操作が完了して いれば成功とする。 レスポンス情報 HTTP ステータス 200 意味 異常 備考 XML ROOT ELEMENT 種別 階層 1 JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード err_cd int 1 1 ○ 2 3 4 5 JSON Element JSON Element JSON Element 論理項目名 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 1：失敗 - - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 - 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 1 コンテンツID content_guid string 0 1 ○ - - - 1n コンテンツID 1 エラー項目 param_name string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 エラー項目値 param_value string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 2.21 - 14 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R176 インタフェース仕様書 4.0 コンテンツ削除 概要 ゴミ箱内コンテンツを完全削除する。 ゴミ箱に入っていないコンテンツは、完全削除できない。 コンテンツの削除により、タグに紐づくコンテンツが無くなった場合、タグ自体が削除される。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/content/delete 3 4 5 6 入力形式 Content-Type 文字コード 備考 JSON application/json UTF-8 リクエスト情報 論理項目名 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 - - - - - - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 JSON Element 1 コンテンツIDリスト content_guid_list array 0 1 ○ 3 JSON Element 2 コンテンツID content_guid string 1 100 ○ 数値 設定値 - ・条件が「1：ファイル指定」の場合 は必須 50 35 説明 詳細は「共通規定」 2を参照 ・削除を行うコンテンツのIDを指定 する。 ※内部的には上限値はプロパ ティで定義する可変値とする 4 JSON Element 1 条件 condition int 1 1 ○ - - - - - 1：ファイル指定 2：ALL指定 ■ファイル指定 指定されたコンテンツに対して、 削除処理を行う。 ■ALL指定 サーバ上でゴミ箱内にある全コ ンテンツに対して、削除処理を行 う RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 論理項目名 処理結果 物理項目名 result データ型 int 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 数値 最大 - 文字列長 最小 最大 0 ： 成功 最小 - 最大 - 文字列長 最小 最大 1：失敗 - 最小 - 設定値 説明 処理結果を下記の値で表す。 0 ： 成功 1 ： 失敗 レスポンス情報 HTTP ステータス 200 意味 異常 備考 XML ROOT ELEMENT 階層 JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード err_cd int 1 1 ○ - - - 3 4 5 JSON Element JSON Element JSON Element 物理項目名 データ型 数値 種別 1 2 論理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 - 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 1 コンテンツID content_guid string 0 1 ○ - - - 1n コンテンツID 1 エラー項目 param_name string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 エラー項目値 param_value string 0 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 2.22 - 15 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R177 インタフェース仕様書 4.0 アップロード（タグ付き） 概要 コンテンツ(原本)を登録する。 コンテンツ登録と同時にアルバムタグの割当を行うことができる。 ただし、アルバムタグが１ユーザの上限に達している場合は、アルバムタグは付与されない。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/4.0/content/create 3 4 5 6 入力形式 Content-Type 文字コード 備考 MULTIPART multipart/form-data UTF-8 リクエスト情報 論理項目名 種別 階層 1 HTTP Header - OAuth認証スキーム Authorization Authorizationヘッダ string 2 Form 1 画像種別コード file_type_cd string 1 1 ○ 3 Form 1 ファイル名 file_name string 1 4 Form 1 ファイルデータサイズ file_data_size string 5 Form 1 MIMEタイプ mime_type 6 Form 1 アルバムタグ名 7 Form 1 ファイル RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 文字列長 最小 最大 - 設定値 説明 最小 - 最大 - - - - 1 1 ○ - - - 1 255 アップロードを行うコンテンツの ファイル名を設定する。 URLエンコードした文字列 1 1 ○ - - - 1 10 アップロードを行うコンテンツの ファイルサイズを設定する。 string 1 1 ○ - - - 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タイプを設定する。 optional_tag_name string 0 1 ○ - - - 1 20 アップロードを行うコンテンツに対 し、アルバムタグを付与する場合 に、アルバムタグ名を設定する。 URLエンコードした文字列 file InputStre am 1 1 ○ - - - - 最小 - 最大 - 文字列長 最小 最大 0 ： 成功 - - 詳細は「共通規定」 2を参照 1 1 : 画像、2 : 動画 - ・'アップロードを行うファイル ・拡張子を含んだ文字列、 Content-Dispositionにfilenameが 必要 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 処理結果 論理項目名 result 物理項目名 int データ型 2 JSON Element 1 データID data_guid string 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 1 1 ○ - 数値 設定値 説明 処理結果を下記の値で表す。 0 ： 成功 1 ： 失敗 75 アップロードされたファイルのデータIDが コンテンツに対してサーバ側で採 番された一意の値 設定される。 35 レスポンス情報 HTTP ステータス 200 意味 異常 備考 XML ROOT ELEMENT 物理項目名 データ型 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 - - - - 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 ○ - - - 1n エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 種別 階層 1 JSON Element JSON Element 1 処理結果 result int 1 エラーステータス コード err_cd int 1 1 ○ 3 JSON Element 1 エラー項目 param_name string 0 4 JSON Element 1 エラー項目値 param_value string 0 2 論理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 2.23 - 16 - 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 インタフェース バージョン インタフェースID /インタフェース名称 IF_XLB_R222 インタフェース仕様書 4.0 コンテンツ情報取得（サムネイル複数） 概要 コンテンツのサムネイル画像を取得する。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://xlb.photocolledocomo.com/file_a2/4.0/ext/thumbnail_list/get 3 4 5 6 入力形式 Content-Type 文字コード 備考 # JSON application/json UTF-8 リクエスト情報 論理項目名 種別 階層 1 HTTP Header - OAuth認証スキーム Authorizationヘッダ Authorization string 2 JSON Element 1 コンテンツIDリスト content_info_list array 1 3 JSON Element 2 コンテンツID content_guid string 1 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 1 ○ - 100 ○ - 最小 - 数値 最大 - 文字列長 最小 最大 - - - - - - 設定値 説明 詳細は「共通規定」 2を参照 - 1 50 内容 JSON application/json UTF-8 リサイズNGフラグ=1(NG)のコンテンツの場合、ダミー画像が返却される。 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 最小 - 最大 - 文字列長 最小 最大 1 1 0 ： 成功 - - - - - - - - - 1 1 ○ - - - 1 string 1 1 ○ - - - 1- thumbnail string 1 1 ○ - - - ng_list array 0 1 ○ - - - string 1 - - 種別 階層 1 JSON Element 1 処理結果 result int 2 JSON Element 1 コンテンツ情報リスト content_info_list array 1 3 JSON Element 2 コンテンツ情報 content_info object 1 4 JSON Element 3 コンテンツID content_guid string 5 JSON Element 3 MIMEタイプ mime_type 6 JSON Element JSON Element 3 JSON Element 2 7 8 1 論理項目名 サムネイル画像 取得失敗リスト 物理項目名 取得失敗コンテンツIDng_content_guid データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 1 ○ 100 ○ 99 ○ - 数値 設定値 処理結果が正常の場合必須 50 取得できたコンテンツID image/jpeg 画像のメディアタイプ 1- 説明 処理結果が正常か失敗かを示 す。 Base64エンコードされたサムネイ ルの画像データ。 1 取得できなかったコンテンツID 50 レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 種別 階層 1 JSON Element JSON Element JSON Element 1 処理結果 result 1 エラーステータス コード エラー項目 err_cd int 1 1 param_name string 0 1 エラー項目値 param_value string 0 2 3 4 JSON Element 論理項目名 物理項目名 データ型 int 最小 - 最大 - 文字列長 最小 最大 1 ： 失敗 1 ○ - - - - 1 ○ - - - 1 ○ - - - 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 項番 数値 2.30 - 17 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 1 64 エラー発生箇所をリクエスト項目 で特定できる場合に、その物理項 目名がセットされる。 1 300 エラー発生箇所をリクエスト項目 で特定できる場合に、エラーの発 生した「エラー項目」の値がセット される。 インタフェースID /インタフェース名称 インタフェース バージョン IF_SLB_R100 インタフェース仕様書 4.0 分割アップロード（UploadIDの取得） 概要 アップロードするコンテンツのメタ情報をJSON形式でサーバにPOSTで送信します。 成功するとサーバはUpload IDを応答します。このUpload IDは 2.32、2.33 以降で必要となります。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://slb.photocolle-docomo.com/app/dcm_slb/api/0.8/Generic2/uploads 3 4 5 入力形式 Content-Type 文字コード JSON application/vnd.com.kii.sync.Generic2+json 自動選択 UTF-8 ・X-kii-client-hash はオプションです。このヘッダを付与した場合、 2.32、 2.33 以降の⼿順で同じ値をif-Matchヘッダとして指定する必要があります。 6 備考 # リクエスト情報 論理項目名 データ型 数値 文字列長 設定値 最小 最大 6 6 固定値"DOCOMO" 種別 階層 1 HTTP Header 1 アプリケーションID X-kii-appid string 2 HTTP Header 1 アプリケーション キー X-kii-appkey string 1 1 ○ - - - 6 6 固定値"DOCOMO" 3 HTTP Header 1 OAuth認証スキーム Authorizationヘッダ Authorization string 1 1 ○ - - - - - 4 HTTP Header 1 クライアントハッシュ X-kii-client-hash string 0 1 - - 1 5 JSON Element 1 GSCT情報 object 1 1 ○ - - RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 項番 最小 - 最大 - - 説明 詳細は「共通規定」 2を参照 64 このヘッダを送信した場合、2.32、2.33以 降も同じ値を送信する必要があります。 アップロード中のファイル変更があり得 る場合は使用を推奨します。 - 詳細は「メタ情報」を参照 内容 JSON application/json UTF-8 自動選択 レスポンス情報 HTTP ステータス 200 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 論理項目名 アップロードID 物理項目名 uploadID データ型 string 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 数値 最小 - 2.31 - 18 最大 - 文字列長 最小 最大 64 64 設定値 説明 インタフェースID /インタフェース名称 インタフェース バージョン IF_SLB_R101 インタフェース仕様書 4.0 分割アップロード（分割アップロード） 概要 GSCT情報のアップロード及びUploadIDの取得で取得したUpload IDを指定し、チャンクをPUTで送信します。チャンクはバイナリ形式で送信します。送信するサイズはcontent-rangeヘッダを使⽤して指定しま す。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド PUT 2 リクエストURI https://slb.photocolledocomo.com/app/dcm_slb/api/0.8/Generic2/uploads/{upload ID}/data 3 4 5 入力形式 Content-Type 文字コード 6 備考 # 自動選択 リクエスト情報 項番 種別 階層 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 文字列長 設定値 最小 最大 64 64 サーバから払いだされたアップロードID 最大 - 1 ○ - - 6 6 固定値"DOCOMO" 1 1 ○ - - - 6 6 固定値"DOCOMO" string 1 1 ○ - - - - - if-match string 0 1 ○ - - 1 content-range string 1 1 ○ - - 10 binary 1 1 ○ - - URI Path - アップロードID {upload ID} string 2 HTTP Header 1 アプリケーションID X-kii-appid string 1 3 HTTP Header 1 アプリケーション キー X-kii-appkey string 4 HTTP Header 1 OAuth認証スキーム Authorizationヘッダ Authorization 5 HTTP Header 1 クライアントハッシュ 6 HTTP Header 1 データ範囲 7 HTTP Body 1 チャンクデータ RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 数値 最小 - 1 - 説明 詳細は「共通規定」 2を参照 64 アップロードID払い出し時にX-kiickient-hashに指定した値 64 送信するデータの範囲 (フォーマットはRFC2616参照) - チャンクデータ(バイナリ) 内容 Bodyなし 自動選択 レスポンス情報 HTTP ステータス 204 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 論理項目名 物理項目名 データ型 項目出現数 最小 最大 null 省略時値 不可 数値 最小 2.32 - 19 最大 文字列長 最小 最大 設定値 説明 インタフェースID /インタフェース名称 インタフェース バージョン IF_SLB_R102 インタフェース仕様書 4.0 分割アップロード（アップロード確定） 概要 チャンクのアップロードで全てのチャンクを送信し終えた後、アップロードの確定を実⾏します。成功するとサーバは追加したレコードのdata-idを応答します。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド POST 2 リクエストURI https://slb.photocolledocomo.com/app/dcm_slb/api/0.8/Generic2/uploads/{upload ID}/status/committed 3 4 5 入力形式 Content-Type 文字コード 6 備考 # 自動選択 リクエスト情報 項番 種別 階層 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 数値 文字列長 設定値 最小 最大 64 64 サーバから払いだされたアップロードID 最小 - 最大 - 1 ○ - - 6 6 固定値"DOCOMO" 1 ○ - - - 6 6 固定値"DOCOMO" 1 URI Path - アップロードID {upload ID} string 2 HTTP Header 1 アプリケーションID X-kii-appid string 1 3 HTTP Header 1 アプリケーション キー X-kii-appkey string 1 4 HTTP Header 1 OAuth認証スキーム Authorizationヘッダ Authorization string 1 1 ○ - - - - 5 HTTP Header 1 クライアントハッシュ if-match string 0 1 ○ - - 1 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 - 説明 詳細は「共通規定」 2を参照 64 アップロードID払い出し時にX-kiickient-hashに指定した値 内容 JSON application/json UTF-8 自動選択 レスポンス情報 HTTP ステータス 201 意味 正常 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element 1 論理項目名 データID 物理項目名 id データ型 string 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 数値 最小 - 2.33 - 20 最大 - 文字列長 設定値 最小 最大 22 41 追加したレコードのデータID 説明 インタフェースID /インタフェース名称 インタフェース バージョン IF_XLB_R045 インタフェース仕様書 1.0 空き容量確認 概要 空き容量確認APIを使用して、ストレージの空き容量を取得することが可能となる。 項番 REST リクエスト 基本情報 項目名 内容 1 HTTPメソッド GET 2 リクエストURI https://xlb.photocolle-docomo.com/file_a2/1.0/docomo/capacity 3 4 5 6 入力形式 Content-Type 文字コード 備考 # UTF-8 リクエスト情報 項番 種別 階層 1 HTTP Header - 論理項目名 OAuth認証スキーム Authorizationヘッダ RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 物理項目名 Authorization データ型 string 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 最大 - 文字列長 最小 最大 - 最小 - 最大 - 文字列長 最小 最大 0 ： 成功 - - 数値 最小 - 設定値 説明 詳細は「共通規定」を参照 内容 JSON application/json UTF-8 レスポンス情報 200 HTTP ステータス 意味 正常 備考 XML ROOT ELEMENT 物理項目名 種別 階層 1 JSON Element JSON Element 1 処理結果 result string 1 最大容量 max_space string 2 論理項目名 データ型 項番 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 0 1 ○ 数値 1 設定値 13 0 ～ 1072668082176 (999Gbyte) 説明 処理結果が正常か失敗かを示 す。 ※PCアプリの時のみ設定される 全サービスでユーザが使用可能 な最大容量（空き容量ではない） 単位はbyte アップロード継続可能なエラーの 場合は、固定値が設定される。 3 JSON Element 1 空き容量 free_space string 1 1 ○ - - 1 13 0 ～ 1072668082176 (999Gbyte) 全サービスでユーザが使用可能 な空き容量 単位はbyte アップロード継続可能なエラーの 場合は、固定値が設定される。 レスポンス情報 HTTP ステータス 200 意味 処理失敗 備考 XML ROOT ELEMENT 項番 種別 階層 1 JSON Element JSON Element 1 処理結果 result string 1 エラーステータス コード err_cd string 2 論理項目名 物理項目名 データ型 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 1 1 ○ - 最小 - 数値 最大 - 文字列長 最小 最大 1：失敗 - - - 3.00 - 21 - 設定値 説明 処理結果が正常か失敗かを示 す。 設定値については「業務エラーマッピン エラーの詳細内容を表すコード。 グ」シート参照 詳細は、「業務エラーコード一覧」 シート参照。 業務外エラー応答形式 各インタフェースのシートには、インタフェース固有の業務エラー応答について記載しているが、それ以外にも認証エラーといった共通的なエラーが存在する。 当該資料では、その共通的エラーについてまとめて記すこととする。 エラー応答パターンの識別 業務エラー以外のエラー応答としては、以下パターンが存在する。 なお、下表の「値あり」項目は、エラーの詳細内訳を識別するための情報が設定されている。 パターン１～７が、どのIFの時に発生しうるかについては、「業務外エラーマッピング」シート参照。（パターン８はどのIFにも発生しうる） HTTPヘッダ 返却パラメータ HTTPステータス Content-Type oauth_problem errorcode パターン番号 発生タイミング 1 400 Bad Request 2 401 Unauthorized text/plain 3 403 Forbidden text/plain OAuth2.0利用時 306 text/plain ※アクセストークン 発行時について 403 Forbidden text/plain は、APＩ運用基盤 のＩＦ仕様書を参照 503 Service Unavailatext/plain のこと 4 5 6 text/plain 7 200 OK 8 500 Internal Server text/plain Error 9 application/json 400 10 共通 err_cd （参考）エラーを返却す るプログラム パターンの説明 error OAuth2.0関連のパラメータ不正/認可情報の検証失敗 ※エラー値については、WWW-Authenticateヘッダに error={エラーコード}の形式で記載・返却される。 - - 値あり※ - - - - 値あり※ - - - - 値あり※ - - - - - - - - - - - - - - - - - 値あり 値あり - - - - - - ＡＰＩ運用基盤との状態不整合エラー もしくは サーバ内処理エラー 拡張LB - トークン検証エラー 分割アップロード利用時のみ発生 SyncLB - text/plain result - - - - - アカウントステータス不正 各ＨＴＴＰステータスコードに対応するユーザの状態は 以下の通り 306 ：強制利用停止のため利用不可 403 ：サービス未登録のため利用不可 503 ：一時的に利用停止のため利用不可 トークン検証時のAPI運用基盤内でのエラー エラー応答パターン1 4 備考 内容 text/plain UTF-8 ・エラー内容等の応答内容については、以下の形式にて、WWW-Authenticate ヘッダ中に含まれる形で応答される WWWAuthenticate:<SP>Bearer<SP>error="xxxxx"<SP>error_description="xxxxxx" ・HTTPレスポンスのbody部には、"Bad Request"という文字列が入る形で応答さ れる。 レスポンス情報 400 HTTP ステータス 意味 認可の失敗 備考 XML ROOT ELEMENT 項番 種別 階層 論理項目名 物理項目名 データ型 1 エラーコード error string 2 エラー詳細 error_description string 項目出現数 null 省略時値 最小 最大 不可 1 1 0 1 - 最小 - 数値 最大 - 文字列長 設定値 最小 最大 invalid_request - - - 最小 - 最大 - 文字列長 最小 最大 invalid_token - - - 最小 - 最大 - 文字列長 設定値 最小 最大 insufficient_scope - - - - ※値はAPI運用基盤で規定 説明 アクセストークンが設定されてい ない場合。 エラー発生理由 エラー応答パターン2 RESTレスポンス 基本情報 項目名 項番 1 出力形式 2 Content-Type 3 文字コード 4 備考 内容 text/plain UTF-8 ・エラー内容等の応答内容については、以下の形式にて、WWW-Authenticate ヘッダ中に含まれる形で応答される WWWAuthenticate:<SP>Bearer<SP>error="xxxxx"<SP>error_description="xxxxxx" ・HTTPレスポンスのbody部には、"Unauthorized"という文字列が入る形で応答 される。 レスポンス情報 401 HTTP ステータス 意味 認可の失敗 備考 XML ROOT ELEMENT 項番 種別 階層 論理項目名 物理項目名 データ型 1 エラーコード error string 2 エラー詳細 error_description string 項目出現数 null 省略時値 最小 最大 不可 1 1 - 0 1 - 数値 - 設定値 ※値はAPI運用基盤で規定 説明 リクエストされたアクセストークン が無効な場合。 または、リクエストされたアクセス トークンが有効期限切れの場合。 エラー発生理由 エラー応答パターン3 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 内容 text/plain UTF-8 ・エラー内容等の応答内容については、以下の形式にて、WWW-Authenticate ヘッダ中に含まれる形で応答される WWWAuthenticate:<SP>Bearer<SP>error="xxxxx"<SP>error_description="xxxxxx" ・HTTPレスポンスのbody部には、"Forbidden"という文字列が入る形で応答され る。 レスポンス情報 HTTP ステータス 項番 種別 階層 403 論理項目名 意味 認可の失敗 物理項目名 備考 データ型 1 エラーコード error string 2 エラー詳細 error_description string 項目出現数 null 省略時値 最小 最大 不可 1 1 0 1 - 数値 エラー応答パターン4 項番 RESTレスポンス 基本情報 項目名 拡張LB 拡張LB 拡張LB 拡張LB エラーの意味は、HTTPステータスコードの定義（RFC 2616）に従う。 ミドルウェアまたはフ ※ JSONなどのリクエスト構文不正は 400 Bad Request レームワーク (Bodyなし）を返却する。 上記以外 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード ＡＰＩ運用基盤からのエ ラー値を連携 内容 エラー応答形式 - 22 - ※値はAPI運用基盤で規定 説明 APIの呼び出しに必要なスコープ が認可されていない場合。 エラー発生理由 1 2 3 出力形式 Content-Type 文字コード text/plain UTF-8 4 備考 ・HTTPレスポンスのbody部には、半角スペースが入る形で応答される。 レスポンス情報 306 HTTP ステータス 項番 種別 階層 当該アカウントが強制利用 停止状態のため利用不可 意味 論理項目名 物理項目名 データ型 備考 項目出現数 最小 最大 null 省略時値 不可 数値 最小 最大 文字列長 最小 最大 設定値 説明 最大 文字列長 最小 最大 設定値 説明 最大 文字列長 最小 最大 設定値 説明 設定値 説明 1 エラー応答パターン5 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 内容 text/plain UTF-8 ・HTTPレスポンスのbody部には、半角スペースが入る形で応答される。 レスポンス情報 403 HTTP ステータス 項番 1 種別 階層 当該アカウントがサービス 未登録のため利用不可 意味 論理項目名 物理項目名 データ型 備考 項目出現数 最小 最大 null 省略時値 不可 数値 最小 HTTP Body エラー応答パターン6 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 備考 内容 text/plain UTF-8 ・HTTPレスポンスのbody部には、半角スペースが入る形で応答される。 レスポンス情報 503 HTTP ステータス 項番 種別 階層 当該アカウントが一時的に 利用停止のため利用不可 意味 論理項目名 物理項目名 データ型 備考 項目出現数 最小 最大 数値 null 省略時値 不可 最小 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ - 最小 - 最大 - 文字列長 最小 最大 1 - - - 最大 文字列長 最小 最大 1 エラー応答パターン7 項番 1 2 3 4 RESTレスポンス 基本情報 項目名 出力形式 Content-Type 文字コード 備考 内容 application/json UTF-8 レスポンス情報 200 HTTP ステータス トークン検証時の API運用基盤内でのエラー 意味 項番 種別 階層 1 JSON Element 1 処理結果 論理項目名 result 物理項目名 int データ型 2 JSON Element 1 エラーコード err_cd int 備考 1 1 ○ - 数値 - 以下のいずれか 900 :内部処理エラー 901 :タイムアウト 902 :パラメータエラー エラー応答パターン8 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 3 文字コード 4 内容 text/plain UTF-8 ・HTTPレスポンスのbody部には、"Internal Server Error"という文字列が入る 形で応答される。 備考 レスポンス情報 HTTP ステータス 項番 種別 階層 500 論理項目名 意味 ＡＰＩ運用基盤との状態不 整合エラー もしくは サーバ内処理エ ラー 物理項目名 データ型 備考 項目出現数 最小 最大 null 省略時値 不可 数値 最小 1 エラー応答パターン9 RESTレスポンス 基本情報 項番 項目名 1 出力形式 2 Content-Type 内容 text/plain エラー応答形式 - 23 設定値 説明 3 4 文字コード 備考 UTF-8 レスポンス情報 HTTP ステータス 項番 1 種別 HTTP Body 階層 1 400 論理項目名 意味 トークンチェック時のエラー 物理項目名 データ型 string 備考 分割アップロード利用時のみ発生する 項目出現数 null 省略時値 最小 最大 不可 1 1 ○ 数値 最小 - 最大 - 文字列長 最小 最大 エラー応答形式 - 24 設定値 Cant get valid address from access token. 説明 業務外エラーマッピング 1 errorcode エラー応答パターン番号 物理項目名 2,3 oauth_problem ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － 400 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － 500 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － 902 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － 901 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － 12 (HTTPステータスコード) 11 err_cd 900 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － 503 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － 403 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － 306 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － insufficient_scope － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － invalid_token ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － invalid_request 業務外エラーマッピング - 25 － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － 8.9.10 HTTPステータスコード 5・6・7 error permission_denied ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － token_rejected ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － token_expired ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － parameter_rejected ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － parameter_absent ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － permission_denied ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － permission_unknown ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － verifier_invalid ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － token_rejected ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － token_expired ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － consumer_key_unknown ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － signature_invalid ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － nonce_used ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － signature_method_reje ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － timestamp_refused 項目値 インタフェース名 コンテンツIDリスト取得 コンテンツIDリスト取得（タグ詳細） タグIDリスト取得 コンテンツ削除履歴取得 コンテンツ情報取得(原本・リサイズ) コンテンツ情報取得(サムネイル) アップロード 空き容量確認 人物タグ追加 人物タグ解除 人物タグ情報編集 イベントタグ追加 イベントタグ解除 イベントタグ情報編集 アルバムタグ追加 アルバムタグ解除 アルバムタグ情報編集 場所タグ追加 場所タグ解除 年月タグ編集 回転情報編集 ゴミ箱移動、復元 コンテンツ削除 アップロード（タグ付き） 共有タググループ情報取得 共有ファイル詳細情報取得（条件指定）(フォトコレユー 共有ファイル詳細情報取得(フォトコレユーザ) 共有コンテンツサムネイル情報取得(フォトコレユーザ) 共有コンテンツリサイズ情報取得(フォトコレユーザ) コンテンツ公開情報取得（閲覧者）(フォトコレユーザ) コンテンツ情報取得(サムネイル複数) 分割アップロード（UploadIDの取得） 分割アップロード（分割アップロード） 分割アップロード（アップロード確定） parameter_rejected 2.0 2.0 2.0 2.0 2.0 2.0 1.0 1.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 4.0 parameter_absent インタフェースID インタフェースバージョン IF_XLB_R090 IF_XLB_R074 IF_XLB_R075 IF_XLB_R080 IF_XLB_R076 IF_XLB_R077 IF_XLB_R046 IF_XLB_R045 IF_XLB_R162 IF_XLB_R163 IF_XLB_R164 IF_XLB_R165 IF_XLB_R166 IF_XLB_R167 IF_XLB_R168 IF_XLB_R169 IF_XLB_R170 IF_XLB_R171 IF_XLB_R172 IF_XLB_R173 IF_XLB_R174 IF_XLB_R175 IF_XLB_R176 IF_XLB_R177 IF_XLB_R178 IF_XLB_R179 IF_XLB_R221 IF_XLB_R062 IF_XLB_R180 IF_XLB_R181 IF_XLB_R222 IF_XLB_R100 IF_XLB_R101 IF_XLB_R102 version_rejected 1003 1004 1005 9001 4 oauth_problem ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － － ○ ○ ○ 業務エラーマッピング ステータスコード エラーコード インター インターフェースID フェース バージョン インターフェース名称 IF_XLB_R090 2.0 コンテンツIDリスト取得 IF_XLB_R074 2.0 コンテンツIDリスト取得（タグ詳細） IF_XLB_R075 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_R162 4.0 ⼈物タグ追加 IF_XLB_R163 4.0 ⼈物タグ解除 IF_XLB_R164 4.0 ⼈物タグ情報編集 IF_XLB_R165 4.0 イベントタグ追加 IF_XLB_R166 4.0 イベントタグ解除 IF_XLB_R167 4.0 イベントタグ情報編集 IF_XLB_R168 4.0 アルバムタグ追加 IF_XLB_R169 4.0 アルバムタグ解除 IF_XLB_R170 4.0 アルバムタグ情報編集 IF_XLB_R171 4.0 場所タグ追加 IF_XLB_R172 4.0 場所タグ解除 IF_XLB_R173 4.0 年⽉タグ編集 IF_XLB_R174 4.0 回転情報編集 IF_XLB_R175 4.0 ゴミ箱移動、復元 IF_XLB_R176 4.0 コンテンツ削除 IF_XLB_R177 4.0 アップロード（タグ付き） IF_XLB_R178 4.0 共有タググループ情報取得 IF_XLB_R179 4.0 共有ファイル詳細情報取得（条件指定） IF_XLB_R221 4.0 共有ファイル詳細情報取得(フォトコレユー IF_XLB_R062 4.0 共有コンテンツサムネイル情報取得(フォト IF_XLB_R180 4.0 共有コンテンツリサイズ情報取得(フォトコ IF_XLB_R181 4.0 IF_XLB_R222 4.0 コンテンツ情報取得(サムネイル複数) IF_SLB_R100 4.0 分割アップロード（UploadIDの取得） IF_SLB_R101 4.0 分割アップロード（分割アップロード） IF_SLB_R102 4.0 分割アップロード（アップロード確定） コンテンツ公開情報取得（閲覧者）(フォト 備考 100 101 102 103 104 109 110 112 113 114 116 150 900 ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ ○ - ○ ○ ○ - ○ - ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - ○ - ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ ○ - 1101 1102 1103 1104 1105 1110 1111 1112 1113 1114 1121 1122 9000 404 ○ - ○ - ○ - - - 業務エラーマッピング - 26 ○ - ○ - ○ - ○ - - - - - ○ ○ 406 409 415 416 420 ○ ○ ○ ○ - ○ - ○ エラーコード一覧 No エラーコード 1 HTTPステータスコード 100 概要 101 200 3 102 200 4 103 200 該当情報なし 取得、更新、削除対象なし。(ファイル、タグ等が存在し ない) 名称重複（タグ） 5 104 109 200 7 110 200 登録最大数超過（タ 登録できる最大数を超過 グ） 8 112 200 保存できる容量を超過、コンテンツの最大サイズを超過 状態不整合 許可されない状態で操作を行った(ゴミ箱操作、タグソー ト/タグ一括登録時のタグ情報不一致等) 共有設定無効 11 116 200 12 150 200 仮登録状態 13 900 200 14 1101 200 15 1102 200 1103 200 17 1104 200 18 1105 200 19 1110 200 1111 200 21 1112 200 22 1113 200 23 1114 200 24 1121 200 25 1122 200 サーバ内で内部処理エラーが発生 （容量超過） 指定容量超過 × コンテンツが重複している ユーザごとの指定容量を超えている × （内部処理エラー） 空き容量が取得できない 空き容量取得エラー コンテンツが存在しない （パラメータエラー） 必須項目不足 必須項目が不足している （パラメータエラー） 項目サイズ不正 項目のサイズが不正である （パラメータエラー） 項目型不正 項目の型が不正である （パラメータエラー） 項目値不正 項目の値が不正である （パラメータエラー） 汎用パラメータエ ラー パラメータが不正である タイムアウト 処理が時間内に終了しない場合 × × × × × ○ 参照系の取扱において、参照結果が0件 × ＊0件を許容していない場合に設定される。 200 27 - 404 - 406 アップロード確認エ ラー パラメータエラー サーバ内で内部処理エラー（不整合等）が発生した場合 × 該当情報なし アップロードIDが存在しない × （分割アップロード(分割アップロード)）if-matchの値が 不一致 （分割アップロード(アップロード確定)）Uniquekeyが重複 している - 409 30 - （パラメータエラー） 415 項目値不正 Content-Typeの値が不正である - （パラメータエラー） 416 項目値不正 Content-rangeの値が不正である 容量超過 × データが最後までアップロードされていない 29 420 × × 9000 - × （内部処理エラー） 最大容量が取得できない 最大容量取得エラー 26 32 × × 内部処理エラー 31 × × 検索結果が0件 28 コンテンツ共有機能利用設定が仮登録状態で、コンテン ツ共有機能を利用した場合のエラー 内部処理エラー × × コンテンツ共有機能利用設定が無効の状態で、コンテン ツ共有機能を利用した場合のエラー リクエスト時に指定できる上限数を超過 該当情報なし 20 登録済み（データ重複） ※タグID,（顔Index）を指定してタグ名を上書きする形に なる場合はエラーは発生しないが、新規追加で同じタグ ID/タグ名を追加するような場合にはエラーが発生す る 参照インタフェースでの結果が0件（0件を許容していな リクエスト上限数超 過 コンテンツ重複 16 × 処理が規定の時間で終わらない い場合） 200 200 × ○ 検索結果が0件 114 × × 登録済み（タグ） 10 × × 容量超過 タイムアウト 113 重複不可のパラメータの名称重複 ※同一のタグID,（顔Index）を指定して同一のタグ名を追 加する場合はエラーは発生しないが、新規追加で同一 のタグ名を追加する場合にはエラーが発生する。 200 6 9 リトライ可否 必須、桁数、文字種別、範囲等の形式チェックエラー ※禁則文字チェックは実施しない。 200 2 説明 パラメータエラー × × × 保存できる容量を超過、コンテンツの最大サイズを超過 × エラーコード一覧 - 27 備考 メタ情報 分割アップロード（UPLOAD ID取得）で利用するメタ情報 以下の項目をUTF-8、JSON形式で作成する。 （JSON形式例） { "CreationTime":"1362025565", "UpdateTime":"1362025565", "MimeType":"image/jpeg" , "Type": "Image" , "Title":"20130228_132605.jpg" , "UniqueKey":"20130228_132605.jpg_20130228132605000_132842 1" , "VirtualRoot":"docomo" , "Size":"1328421" 送信 個数 最大長 (byte) String 1 11 String 1 255 1 9 1 10 1 10 項目 Property 1 ファイルタイプ Type 2 ファイル名 Title 3 サイズ Size 4 情報作成日時 ファイルのサイズ Long (byte) 情報が作成された日時 CreationTime Long 5 情報更新日時 UpdateTime 6 7 8 MIMEタイプ ユニークキー 仮想ルート MimeType UniqueKey VirtualRoot 説明 プロパティ フィールド型 No. ファイルの種別 ファイルの名称 情報が更新された日 時 Long (タグ編集などの更新 も含む) MIMEタイプ String 重複チェックで使用する String ためのユニークキー “docomo“固定の値を 常に指定。 1 1 15 300 備考 画像⇒Image 動画⇒Video 255byte以内の文字列 1～100M(動画MAX時のサイズ) UnixTime (端末で撮影日を設定する。撮影日が取得 できない場合は、ファイル作成日を設定 UnixTime 【画像コンテンツ】 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) 300byte以内の文字列 (ファイル名+撮影日+ファイルサイズを "_"区切りで結合したもの) exifで撮影日が取得できないものは、撮 影日部分は0パディングとする。 (撮影日部のフォーマットは yyyymmddhhmmsssssとする。） ※同一の値を持つレコードが存在した場 合は重複エラーが発生する [例] Image001.jpg_20120201102233444_1024 “docomo“固定 String 1 6 別紙1 １．場所タグマスタ place_tag_id 1001 2002 2003 2004 2005 2006 2007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 4018 4019 4020 5021 5022 5023 5024 6025 6026 6027 6028 6029 6030 7031 7032 7033 7034 7035 8036 8037 8038 8039 9040 9041 9042 9043 9044 9045 9046 9047 101001 101002 101003 101004 101005 102006 102007 102008 102009 102010 102011 102012 102013 102014 102015 102016 102017 102018 102019 102020 102021 place_name 北海道 青森 岩手 宮城 秋田 山形 福島 茨城 栃木 群馬 埼玉 千葉 東京 神奈川 新潟 長野 山梨 富山 石川 福井 岐阜 静岡 愛知 三重 滋賀 京都 大阪 兵庫 奈良 和歌山 鳥取 島根 岡山 広島 山口 徳島 香川 愛媛 高知 福岡 佐賀 長崎 熊本 大分 宮崎 鹿児島 沖縄 アメリカ カナダ グアム サイパン ハワイ 韓国 台湾 中国 香港 インド インドネシア カンボジア シンガポール スリランカ タイ ネパール パキスタン バングラデシュ フィリピン ベトナム マカオ 別紙1 - 29 102022 102023 102024 102025 102026 102027 102028 102029 102030 103026 103027 103028 103029 103030 103031 103032 103033 103034 103035 103036 103037 103038 103039 103040 104031 104032 104033 104034 104035 104036 104037 104038 104039 104040 104041 104042 104043 104044 104045 104046 104047 104048 104049 104050 104051 104052 104053 104054 104055 104056 104057 104058 104059 104060 104061 104062 104063 104064 104065 104066 104067 104068 104069 104070 104071 104072 104073 104074 104075 104076 104077 104078 104079 マレーシア モルディブ モンゴル ラオス 朝鮮民主主義人民共和国 東ティモール ミャンマー ブルネイ・ダルサラーム ブータン オーストラリア ニューカレドニア ニュージーランド パラオ フィジー キリバス サモア ソロモン諸島 ツバル トンガ ナウル バヌアツ パプアニューギニア マーシャル諸島 ミクロネシア連邦 アイスランド アイルランド アルメニア イギリス イタリア ウクライナ エストニア オーストリア オランダ カザフスタン ギリシャ クロアチア サンマリノ スイス スウェーデン スペイン スロバキア スロベニア チェコ デンマーク ドイツ トルコ ノルウェー ハンガリー フィンランド フランス ブルガリア ベルギー ポーランド ポルトガル モナコ ラトビア リトアニア ルーマニア ロシア アゼルバイジャン アルバニア アンドラ ウズベキスタン キプロス キルギス ジョージア セルビア タジキスタン トルクメニスタン ベラルーシ ボスニア・ヘルツェゴビナ マケドニア旧ユーゴスラビア共和国 マルタ 別紙1 - 30 104080 104081 104082 104083 105066 105067 105068 105069 105070 105071 105072 105073 105074 105075 105076 105077 105078 105079 105080 105081 105082 105083 105084 105085 105086 105087 105088 105089 105090 105091 105092 105093 105094 105095 105096 105097 105098 106078 106079 106080 106081 106082 106083 106084 106085 106086 106087 106088 106089 106090 106091 107085 107086 107087 107088 107089 107090 107091 107092 107093 107094 107095 107096 107097 107098 107099 107100 107101 107102 107103 107104 107105 107106 モルドバ共和国 モンテネグロ リヒテンシュタイン ルクセンブルク アルゼンチン エクアドル キューバ グアテマラ コスタリカ コロンビア チリ パナマ ブラジル ペルー ボリビア メキシコ アンティグア・バーブーダ ウルグアイ エルサルバドル ガイアナ グレナダ ジャマイカ スリナム セントクリストファー・ネイビス セントビンセントおよびグレナディーン諸島 セントルシア ドミニカ共和国 ドミニカ国 トリニダード・トバゴ ニカラグア ハイチ バハマ パラグアイ バルバドス ベネズエラ・ボリバル共和国 ベリーズ ホンジュラス イスラエル オマーン クウェート サウジアラビア シリア バーレーン ヨルダン アフガニスタン アラブ首長国連邦 イエメン イラク イラン・イスラム共和国 カタール レバノン エジプト ケニア ザンビア ジンバブエ チュニジア ナイジェリア マダガスカル 南アフリカ共和国 モロッコ アルジェリア アンゴラ ウガンダ エチオピア エリトリア ガーナ カーボベルデ ガボン カメルーン ガンビア ギニアビサウ ギニア コートジボワール 別紙1 - 31 107107 107108 107109 107110 107111 107112 107113 107114 107115 107116 107117 107118 107119 107120 107121 107122 107123 107124 107125 107126 107127 107128 107129 107130 107131 107132 107133 107134 107135 107136 107137 107138 108094 コモロ コンゴ共和国 コンゴ民主共和国 サントメ・プリンシペ シエラレオネ ジブチ スーダン スワジランド セーシェル セネガル ソマリア タンザニア チャド トーゴ ナミビア ニジェール ブルキナファソ ブルンジ ベナン ボツワナ マラウイ マリ モーリシャス モーリタニア モザンビーク リビア リベリア ルワンダ レソト 赤道ギニア 中央アフリカ共和国 南スーダン その他 ２．状態に対応する内容 状態の内容と処理状況の対応表は以下となる。 状態 状態名 処理状況 リサイズ・ サムネイル 分析 作成 ※1 原本 保存 説明 0 変換中 ○ ― ― サーバへのコンテンツの原本 の保存が完了した状態。 1 アップロード完了 （分析完了：同期可能な状態） ○ ○ ○ サーバでコンテンツの分析ま で完了した状態。 2 変換失敗(リサイズ失敗) ○ × ○ リサイズ・サムネイル作成が 失敗した状態。 ※１ リサイズとサムネイルが成功した場合、「○」となる。どちらか一方でも失敗の場合、 「×」となる。 別紙1 - 32