ユーザーAPI/食事の単一参照の変更点

追加された行はこの色です。
削除された行はこの色です。
ユーザーAPI/食事の単一参照へ行く。
[[FrontPage]]

&size(24){ユーザーAPI/食事の単一参照};

* API情報 [#q6190828]

|~名称|食事の単一参照|
|~APIバージョン|1|
|~認証タイプ|ユーザー認証|
|~URL|&#104;&#116;&#116;&#112;&#115;&#58;&#47;&#47;&#40;&#65;&#80;&#73;&#12469;&#12540;&#12496;&#12540;&#21517;&#41;/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|god(固定)|string定数|必須|オペレーション&br;god = GETオペレーション|
|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]
 objectsetタグ: ルートノード
 idタグ: 食事ID [必須]

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

* 返値 [#e86e04c1]

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

結果データの配列
|変数名|型|内容|h
|meal|array|食事の情報|
|hashkey|hash|食事のハッシュ値|
|food|array|食事に含まれる食品の情報|

結果データ meal の配列
|変数名|型|内容|h
|mealid|string|食事ID|
|cdate|date|作成日時|
|feedingdate|date|食事日時|
|correct_text|string|メモ|
|segment|integer|セグメント|

結果データ food の配列
|変数名|型|内容|h
|objectid|string|食品オブジェクトID|
|quantity|float|分量|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"struct":[
		{
			"meal":{
				"mealid":"M27c7eae252f43c91ee40",
				"cdate":"2014\/02\/07 10:53:21",
				"feedingdate":"2014\/02\/07 10:53:19",
				"correct_text":"",
				"segment":"1"
			},
			"hashkey":"a41469fec63e78a71356df92c447c758f3896ecf",
			"food":[
				{
					"objectid":"FOc3b36c434682c01d0f5abba7",
					"quantity":2
				}
			]
		},
		{
			"meal":{
				"mealid":"M27c7eae252f43c913533",
				"cdate":"2014\/02\/07 10:53:21",
				"feedingdate":"2014\/02\/07 10:53:19",
				"correct_text":"",
				"segment":"1"
			},
			"hashkey":"cc983eb6d77c4ba98d79d4ce2e8da613a7617db9",
			"food":[
				{
					"objectid":"FO7d2e0e054666526c37c5d5a6",
					"quantity":1
				},
				{
					"objectid":"FO602dd9eb47944ae36e71e45e",
					"quantity":1
				},
				{
					"objectid":
					"FO3cc1bb8745d44ff97ba8c6fe",
					"quantity":1
				}
			]
		}
	]
}
</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;meal&gt;
				&lt;mealid&gt;M27c7eae252f43c91ee40&lt;/mealid&gt;
				&lt;cdate&gt;2014/02/07 10:53:21&lt;/cdate&gt;
				&lt;feedingdate&gt;2014/02/07 10:53:19&lt;/feedingdate&gt;
				&lt;correct_text&gt;&lt;/correct_text&gt;
				&lt;segment&gt;1&lt;/segment&gt;
			&lt;/meal&gt;
			&lt;hashkey&gt;a41469fec63e78a71356df92c447c758f3896ecf&lt;/hashkey&gt;
			&lt;food&gt;
				&lt;item&gt;
					&lt;objectid&gt;FOc3b36c434682c01d0f5abba7&lt;/objectid&gt;
					&lt;quantity&gt;2&lt;/quantity&gt;
				&lt;/item&gt;
			&lt;/food&gt;
		&lt;/item&gt;
		&lt;item&gt;
			&lt;meal&gt;
				&lt;mealid&gt;M27c7eae252f43c913533&lt;/mealid&gt;
				&lt;cdate&gt;2014/02/07 10:53:21&lt;/cdate&gt;
				&lt;feedingdate&gt;2014/02/07 10:53:19&lt;/feedingdate&gt;
				&lt;correct_text&gt;&lt;/correct_text&gt;
				&lt;segment&gt;1&lt;/segment&gt;
			&lt;/meal&gt;
			&lt;hashkey&gt;cc983eb6d77c4ba98d79d4ce2e8da613a7617db9&lt;/hashkey&gt;
			&lt;food&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO7d2e0e054666526c37c5d5a6&lt;/objectid&gt;
					&lt;quantity&gt;1&lt;/quantity&gt;
				&lt;/item&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO602dd9eb47944ae36e71e45e&lt;/objectid&gt;
					&lt;quantity&gt;1&lt;/quantity&gt;
				&lt;/item&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO3cc1bb8745d44ff97ba8c6fe&lt;/objectid&gt;
					&lt;quantity&gt;1&lt;/quantity&gt;
				&lt;/item&gt;
			&lt;/food&gt;
		&lt;/item&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/食事の単一参照]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|
ユーザーAPI/食事の単一参照 の変更点

ユーザーAPI/食事の単一参照の変更点
