ユーザー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|
|~データ形式|multipart/form-data|

* 概要 [#jfe13a2c]

過去の写真データに基づいて類似の食事を検索する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bu(固定)|string定数|必須|コマンド&br;Bu = ユーザー認証付きBBAPIを呼び出す|
|Category|XST(固定)|string定数|必須|オペレーションカテゴリー&br;XST = エクストラサービス|
|Operation|cal(固定)|string定数|必須|オペレーション&br;cal = CALLオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|UserAuth|ユーザー認証タイプ|string|必須|userhashbb|
|uid|モバイルダイエットID|string|uidまたはloginidのいずれか必須|ユーザーのモバイルダイエットID|
|loginid|ログインID|string|uidまたはloginidのいずれか必須|ユーザーのログインID|
|password|パスワードハッシュ値|hash|必須|sha1(アプリケーションシークレット+パスワード) の値|
|StructData|アップロードデータ|xml|必須|アップロードする写真データの情報|
|Pict(uploadid)|画像データ|binary|必須|XML中で指定されたアップロードデータ&br;1ファイルは最大で2Mバイトまで&br;(uploadid)部分は任意の文字列であってXML中で指定&br;|
|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]
 CallServiceタグ: ルートノード
 ServiceNameタグ: サービス指定子 UserRecognizePicture1固定 [必須]
 pictsetタグ: 入力する写真 [必須]
 
 (以下pictsetの中に配置可能)
 pictobjectタグ: 写真オブジェクト [最低でも1つは必須]

 (以下pictobjectの中に配置可能)
 typeタグ: 写真タイプ 0固定 [必須]
 dateタグ: アップロード日時 [必須]
 uploadidタグ: multipart/form-dataの画像データを含むパートのパラメータ名 [必須]
 uploadhashタグ: アップロードする画像データのsha1ハッシュ値 [必須]
 

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


* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|category|string|実行されたカテゴリー名 RGP固定|
|registed|integer|受信された写真数|
|struct|array|結果の配列|

結果の配列
|変数名|型|内容|h
|feedingdate|date|食事日時|
|refpict|array|被参照写真|
|foodobject|array|食事を構成する食品|

被参照写真
|変数名|型|内容|h
|pictid|string|画像オブジェクトID|
|type|string|画像ソース区分|

食事を構成する食品
|変数名|型|内容|h
|objectid|string|食品オブジェクトID|
|quantity|float|分量|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1,"struct":[
		{
			"feedingdate":"2012\/12\/04 09:44:00",
			"refpict":{
				"pictid":"VyJfFZQpFoZvhlSC9jpA1EoB",
				"type":"userpictlib"
			},
			"foodobject":[
				{
					"objectid":"FO01192397471c08790585fb12",
					"quantity":"1.0000"
				},
				{
					"objectid":"FO9a58f57646c9455b3ecac928",
					"quantity":"1.0000"
				}
			]
		},
		{
			"feedingdate":"2013\/03\/11 07:40:56",
			"refpict":{
				"pictid":"a39J2RZygXFxnZyIyrm3162D",
				"type":"userpictlib"
			},
			"foodobject":[
				{
					"objectid":"FOffbf77ba470b1f767c74f581",
					"quantity":"1.0000"
				},
				{
					"objectid":"FO26a31797469c6a95232ff62c",
					"quantity":"1.0000"
				}
			]
		}
	]
}
</pre>
}}


** XMLの例 [#a81f6668]
#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;api_rescode&gt;1&lt;/api_rescode&gt;
	&lt;struct&gt;
		&lt;item&gt;
			&lt;feedingdate&gt;2012/12/04 09:44:00&lt;/feedingdate&gt;
			&lt;refpict&gt;
				&lt;pictid&gt;VyJfFZQpFoZvhlSC9jpA1EoB&lt;/pictid&gt;
				&lt;type&gt;userpictlib&lt;/type&gt;
			&lt;/refpict&gt;
			&lt;foodobject&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO01192397471c08790585fb12&lt;/objectid&gt;
					&lt;quantity&gt;1.0000&lt;/quantity&gt;
				&lt;/item&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO9a58f57646c9455b3ecac928&lt;/objectid&gt;
					&lt;quantity&gt;1.0000&lt;/quantity&gt;
				&lt;/item&gt;
			&lt;/foodobject&gt;
		&lt;/item&gt;
		&lt;item&gt;
			&lt;feedingdate&gt;2013/03/11 07:40:56&lt;/feedingdate&gt;
			&lt;refpict&gt;
				&lt;pictid&gt;a39J2RZygXFxnZyIyrm3162D&lt;/pictid&gt;
				&lt;type&gt;userpictlib&lt;/type&gt;
			&lt;/refpict&gt;
			&lt;foodobject&gt;
				&lt;item&gt;
					&lt;objectid&gt;FOffbf77ba470b1f767c74f581&lt;/objectid&gt;
					&lt;quantity&gt;1.0000&lt;/quantity&gt;
				&lt;/item&gt;
				&lt;item&gt;
					&lt;objectid&gt;FO26a31797469c6a95232ff62c&lt;/objectid&gt;
					&lt;quantity&gt;1.0000&lt;/quantity&gt;
				&lt;/item&gt;
			&lt;/foodobject&gt;
		&lt;/item&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/写真類似検索]] &br;

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|
ユーザーAPI/写真類似検索 の変更点

ユーザーAPI/写真類似検索の変更点
