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

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	god(固定)	string定数	必須	オペレーション 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定数	任意	出力フォーマット指定省略時json(またはアプリケーションキー毎に指定のフォーマット)
Charset	UTF-8,SJIS,EUC-JP	string定数	任意	出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8

認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照

↑

アップロードデータXML†

↑

データ定義XML構成†

objectsetタグ: ルートノード
idタグ: 食事ID [必須]

↑

XML例†

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<objectset>
  <id>Mecf63c1152cf2bf109eb</id>
  <id>Mecf63c1152cf2c8a94c7</id>
</objectset>

↑

返値†

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

結果データの配列

変数名	型	内容
meal	array	食事の情報
hashkey	hash	食事のハッシュ値
food	array	食事に含まれる食品の情報

結果データ meal の配列

変数名	型	内容
mealid	string	食事ID
cdate	date	作成日時
feedingdate	date	食事日時
correct_text	string	メモ
segment	integer	セグメント

結果データ food の配列

変数名	型	内容
objectid	string	食品オブジェクトID
quantity	float	分量

↑

JSONの例†

{
	"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
				}
			]
		}
	]
}

↑

XMLの例†

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<api_result>1</api_result>
	<struct>
		<item>
			<meal>
				<mealid>M27c7eae252f43c91ee40</mealid>
				<cdate>2014/02/07 10:53:21</cdate>
				<feedingdate>2014/02/07 10:53:19</feedingdate>
				<correct_text></correct_text>
				<segment>1</segment>
			</meal>
			<hashkey>a41469fec63e78a71356df92c447c758f3896ecf</hashkey>
			<food>
				<item>
					<objectid>FOc3b36c434682c01d0f5abba7</objectid>
					<quantity>2</quantity>
				</item>
			</food>
		</item>
		<item>
			<meal>
				<mealid>M27c7eae252f43c913533</mealid>
				<cdate>2014/02/07 10:53:21</cdate>
				<feedingdate>2014/02/07 10:53:19</feedingdate>
				<correct_text></correct_text>
				<segment>1</segment>
			</meal>
			<hashkey>cc983eb6d77c4ba98d79d4ce2e8da613a7617db9</hashkey>
			<food>
				<item>
					<objectid>FO7d2e0e054666526c37c5d5a6</objectid>
					<quantity>1</quantity>
				</item>
				<item>
					<objectid>FO602dd9eb47944ae36e71e45e</objectid>
					<quantity>1</quantity>
				</item>
				<item>
					<objectid>FO3cc1bb8745d44ff97ba8c6fe</objectid>
					<quantity>1</quantity>
				</item>
			</food>
		</item>
	</struct>
</response>

↑

サンプル†

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

↑

バージョン†

このドキュメントのバージョン情報

Version	1
Revision	1
Editor	west