ユーザーAPI/写真のライブラリ一覧取得 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• ユーザーAPI/写真のライブラリ一覧取得 へ行く。

[[FrontPage]]

&size(24){ユーザーAPI/写真のライブラリ一覧取得};

* API情報 [#q6190828]

|~名称|写真のライブラリ一覧取得|
|~APIバージョン|1|
|~認証タイプ|ユーザー認証|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|application/x-www-form-urlencoded|

* 概要 [#jfe13a2c]

ユーザーピクチャーライブラリの登録データ一覧を取得する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bu(固定)|string定数|必須|コマンド&br;Bu = ユーザー認証付きBBAPIを呼び出す|
|Category|UPL(固定)|string定数|必須|オペレーションカテゴリー&br;UPL = ユーザーピクチャーライブラリ|
|Operation|gsl(固定)|string定数|必須|オペレーション&br;gsl = GETSUMMARYLISTオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|UserAuth|ユーザー認証タイプ|string|必須|userhashbb|
|uid|モバイルダイエットID|string|uidまたはloginidのいずれか必須|ユーザーのモバイルダイエットID|
|loginid|ログインID|string|uidまたはloginidのいずれか必須|ユーザーのログインID|
|password|パスワードハッシュ値|hash|必須|sha1(アプリケーションシークレット+パスワード) の値|
|StructData|アップロードデータ|xml|必須|検索クエリーデータ|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,UserAuth,uid,passwordについては、[[API認証>API認証#authtype_user]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

* アップロードデータXML [#d1118dc6]

** データ定義XML構成 [#sbcdc85d]
 QuerySetタグ: ルートノード
 qtypeタグ: クエリータイプ UserPictLib固定 [必須]
 tagtypeタグ: タグタイプ ステージング=1 食事アルバム=2 モバイルセッション=3 [任意]

** XML例 [#g9ecbe25]
#html{{
<pre class="brush:xml;">
}}
#htmlinsert(samxml_mobadaiapi_userpictlib_list.xml)
#html{{
</pre>
}}

* 返値 [#e86e04c1]
|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|count|array|結果データの数|
|struct|array|結果データの配列|
結果データの配列
|変数名|型|内容|h
|objectid|string|ユーザーピクチャーライブラリオブジェクトID|
|cdate|string|生成日時|
|mealid|string|関連づけされた食事ID(存在すれば)|
|stageid|string|関連づけされたステージングID(存在すれば)|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1,
	"count":3,
	"struct":[
		{
			"objectid":"HAhdoB0gDH0AfBMt6O8Z3vWg",
			"cdate":"2014\/03\/25 07:35:51"
		},
		{
			"objectid":"Kv4LQ0EfDlv6jspofKlv2lS1",
			"cdate":"2014\/03\/25 07:33:18"
		},
		{
			"objectid":"xv0QaCTQPkg75HuvlprF2udk",
			"cdate":"2014\/03\/25 07:18:46"
		}
	]
}
</pre>
}}

** XMLの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;response&gt;
	&lt;api_result&gt;1&lt;/api_result&gt;
	&lt;api_rescode&gt;1&lt;/api_rescode&gt;
	&lt;count&gt;3&lt;/count&gt;
	&lt;struct&gt;
		&lt;item&gt;
			&lt;objectid&gt;HAhdoB0gDH0AfBMt6O8Z3vWg&lt;/objectid&gt;
			&lt;cdate&gt;2014/03/25 07:35:51&lt;/cdate&gt;
		&lt;/item&gt;
		&lt;item&gt;
			&lt;objectid&gt;Kv4LQ0EfDlv6jspofKlv2lS1&lt;/objectid&gt;
			&lt;cdate&gt;2014/03/25 07:33:18&lt;/cdate&gt;
		&lt;/item&gt;
		&lt;item&gt;
			&lt;objectid&gt;xv0QaCTQPkg75HuvlprF2udk&lt;/objectid&gt;
			&lt;cdate&gt;2014/03/25 07:18:46&lt;/cdate&gt;
		&lt;/item&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}


* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/写真のライブラリ一覧取得]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|