ユーザー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|UM(固定)|string定数|必須|オペレーションカテゴリー&br;UM = ユーザー食事データ|
|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タグ: クエリータイプ UserMealLog固定 [必須]
 startdateタグ: 取得開始日時 [必須]
 enddateタグ: 取得終了日時 [必須]
 detailタグ: 詳細データ取得フラグ [任意]

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

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|struct|array|結果データの配列|

結果データの配列
|変数名|型|内容|h
|userid|string|ユーザーID|
|mealid|string|食事ID|
|hashkey|hash|食事のハッシュ値|
|meal|array|(詳細フラグONの時) 食事の情報|
|food|array|(詳細フラグONの時) 食事に含まれる食品の情報|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"struct":[
		{
			"mealid":"M27c7eae252f4384e8cd3",
			"hashkey":"8575b6e13437287e8d30851753b7e3e39d69da5c"
		},
		{
			"mealid":"M27c7eae252f43960abb6",
			"hashkey":"110c1bc0121902ae5ad74027c114a415ac68e1c9"
		},
		{
			"mealid":"M27c7eae252f43a8fa3de",
			"hashkey":"436b52bbbaad8a193b720e40f90021d029bdc350"
		},
		{
			"mealid":"M27c7eae252f43ab43aee",
			"hashkey":"24eb337d8e95fef7a60f6b2e31d7f32a463a433b"
		},
		{
			"mealid":"M27c7eae252f43c91ee40",
			"hashkey":"a41469fec63e78a71356df92c447c758f3896ecf"
		}
	]
}
</pre>
}}

** XMLの例 [#wb22f315]
#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;struct&gt;
      &lt;item&gt;
        &lt;mealid&gt;M27c7eae252f4384e8cd3&lt;/mealid&gt;
        &lt;hashkey&gt;8575b6e13437287e8d30851753b7e3e39d69da5c&lt;/hashkey&gt;
      &lt;/item&gt;
      &lt;item&gt;
        &lt;mealid&gt;M27c7eae252f43960abb6&lt;/mealid&gt;
        &lt;hashkey&gt;110c1bc0121902ae5ad74027c114a415ac68e1c9&lt;/hashkey&gt;
      &lt;/item&gt;
      &lt;item&gt;
        &lt;mealid&gt;M27c7eae252f43c91ee40&lt;/mealid&gt;
        &lt;hashkey&gt;a41469fec63e78a71356df92c447c758f3896ecf&lt;/hashkey&gt;
      &lt;/item&gt;
    &lt;/struct&gt;
  &lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/食事の一覧取得]]


* バージョン [#o0becc47]

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