![[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 | UM(固定) | string定数 | 必須 | オペレーションカテゴリー UM = ユーザー食事データ |
| 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タグ: クエリータイプ UserMealLog固定 [必須] startdateタグ: 取得開始日時 [必須] enddateタグ: 取得終了日時 [必須] detailタグ: 詳細データ取得フラグ [任意]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <QuerySet> <qtype>UserMealLog</qtype> <startdate>2013/12/11 00:00:00</startdate> <enddate>2014/01/10 00:00:00</enddate> <detail>0</detail> </QuerySet>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| struct | array | 結果データの配列 |
結果データの配列
| 変数名 | 型 | 内容 |
| userid | string | ユーザーID |
| mealid | string | 食事ID |
| hashkey | hash | 食事のハッシュ値 |
| meal | array | (詳細フラグONの時) 食事の情報 |
| food | array | (詳細フラグONの時) 食事に含まれる食品の情報 |
{
"api_result":true,
"struct":[
{
"mealid":"M27c7eae252f4384e8cd3",
"hashkey":"8575b6e13437287e8d30851753b7e3e39d69da5c"
},
{
"mealid":"M27c7eae252f43960abb6",
"hashkey":"110c1bc0121902ae5ad74027c114a415ac68e1c9"
},
{
"mealid":"M27c7eae252f43a8fa3de",
"hashkey":"436b52bbbaad8a193b720e40f90021d029bdc350"
},
{
"mealid":"M27c7eae252f43ab43aee",
"hashkey":"24eb337d8e95fef7a60f6b2e31d7f32a463a433b"
},
{
"mealid":"M27c7eae252f43c91ee40",
"hashkey":"a41469fec63e78a71356df92c447c758f3896ecf"
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<api_result>1</api_result>
<struct>
<item>
<mealid>M27c7eae252f4384e8cd3</mealid>
<hashkey>8575b6e13437287e8d30851753b7e3e39d69da5c</hashkey>
</item>
<item>
<mealid>M27c7eae252f43960abb6</mealid>
<hashkey>110c1bc0121902ae5ad74027c114a415ac68e1c9</hashkey>
</item>
<item>
<mealid>M27c7eae252f43c91ee40</mealid>
<hashkey>a41469fec63e78a71356df92c447c758f3896ecf</hashkey>
</item>
</struct>
</response>
PHPサンプル サンプル/PHP/ユーザーAPI/食事の一覧取得
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
