![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
ユーザーAPI/写真のライブラリ一覧取得
| 名称 | 写真のライブラリ一覧取得 |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | ユーザー認証 |
| URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | application/x-www-form-urlencoded |
ユーザーピクチャーライブラリの登録データ一覧を取得する。
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bu(固定) | string定数 | 必須 | コマンド Bu = ユーザー認証付きBBAPIを呼び出す |
| Category | UPL(固定) | string定数 | 必須 | オペレーションカテゴリー UPL = ユーザーピクチャーライブラリ |
| Operation | gsl(固定) | string定数 | 必須 | オペレーション 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定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
QuerySetタグ: ルートノード qtypeタグ: クエリータイプ UserPictLib固定 [必須] tagtypeタグ: タグタイプ ステージング=1 食事アルバム=2 モバイルセッション=3 [任意]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <QuerySet> <qtype>UserPictLib</qtype> <tagtype>1/<tagtype> </QuerySet>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| count | array | 結果データの数 |
| struct | array | 結果データの配列 |
結果データの配列
| 変数名 | 型 | 内容 |
| objectid | string | ユーザーピクチャーライブラリオブジェクトID |
| cdate | string | 生成日時 |
| mealid | string | 関連づけされた食事ID(存在すれば) |
| stageid | string | 関連づけされたステージングID(存在すれば) |
{
"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"
}
]
}
<?xml version="1.0" encoding="UTF-8"?> <response> <api_result>1</api_result> <api_rescode>1</api_rescode> <count>3</count> <struct> <item> <objectid>HAhdoB0gDH0AfBMt6O8Z3vWg</objectid> <cdate>2014/03/25 07:35:51</cdate> </item> <item> <objectid>Kv4LQ0EfDlv6jspofKlv2lS1</objectid> <cdate>2014/03/25 07:33:18</cdate> </item> <item> <objectid>xv0QaCTQPkg75HuvlprF2udk</objectid> <cdate>2014/03/25 07:18:46</cdate> </item> </struct> </response>
PHPサンプル サンプル/PHP/ユーザーAPI/写真のライブラリ一覧取得
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
