ユーザー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	XST(固定)	string定数	必須	オペレーションカテゴリー XST = エクストラサービス
Operation	cal(固定)	string定数	必須	オペレーション cal = CALLオペレーション
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構成†

CallServiceタグ: ルートノード
ServiceNameタグ: サービス指定子 UserMealAnalyzeDay1固定 [必須]
Paramタグ: 入力パラメータ [任意]
modeタグ: 動作モード [任意] getdesc:サービス定義記述のみを返却
dateタグ: 指定日 [任意] 省略時はアクセスした日付

↑

XML例†

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<CallService>
	<ServiceName>UserMealAnalyzeDay1</ServiceName>
	<Param>
		<date>2013/01/17</date>
	</Param>
</CallService>

↑

返値†

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

結果データの配列

変数名	型	内容
stuffid	string	栄養素ID
stuffname	string	栄養素名
unitname	string	単位
border	float	標準量
value	float	摂取量
perc	float	充足率

↑

JSONの例†

{
	"api_result":true,
	"api_rescode":1,
	"struct":[
		{
			"stuffid":"stuff_e",
			"stuffname":"\u30ab\u30ed\u30ea\u30fc",
			"unitname":"kcal",
			"border":1716,
			"value":2135.1778,
			"perc":124},
		{
			"stuffid":"stuff_p",
			"stuffname":"\u86cb\u767d\u8cea",
			"unitname":"g",
			"border":50,
			"value":78.4558,
			"perc":157},
// ... 中略 ...
		{
			"stuffid":"iodine",
			"stuffname":"\u30e8\u30a6\u7d20",
			"unitname":"\u03bcg",
			"border":95,
			"value":17.512,
			"perc":18},
		{
			"stuffid":"selen",
			"stuffname":"\u30bb\u30ec\u30f3",
			"unitname":"\u03bcg",
			"border":25,
			"value":114.02,
			"perc":456}
	]
}

↑

XMLの例†

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <api_result>1</api_result>
  <api_rescode>1</api_rescode>
  <struct>
    <item>
      <stuffid>stuff_e</stuffid>
      <stuffname>カロリー</stuffname>
      <unitname>kcal</unitname>
      <border>1716</border>
      <value>2135.1778</value>
      <perc>124</perc>
    </item>
    <item>
      <stuffid>stuff_p</stuffid>
      <stuffname>蛋白質</stuffname>
      <unitname>g</unitname>
      <border>50</border>
      <value>78.4558</value>
      <perc>157</perc>
    </item>
    <item>
      <stuffid>stuff_fac1</stuffid>
      <stuffname>飽和脂肪酸</stuffname>
      <unitname>g</unitname>
      <border>5.75</border>
      <value>14.9984</value>
      <perc>261</perc>
    </item>
// ... 中略 ...
    <item>
      <stuffid>iodine</stuffid>
      <stuffname>ヨウ素</stuffname>
      <unitname>μg</unitname>
      <border>95</border>
      <value>17.512</value>
      <perc>18</perc>
    </item>
    <item>
      <stuffid>selen</stuffid>
      <stuffname>セレン</stuffname>
      <unitname>μg</unitname>
      <border>25</border>
      <value>114.02</value>
      <perc>456</perc>
    </item>
</struct>
</response>

↑

サンプル†

PHPサンプルサンプル/PHP/ユーザーAPI/栄養充足率の取得

↑

バージョン†

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

Version	1
Revision	1
Editor	west