バイパスキーAPI/画像認識終了処理 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• バイパスキーAPI/画像認識終了処理 へ行く。

[[FrontPage]]

&size(24){バイパスキーAPI/画像認識終了処理};

* API情報 [#q6190828]

|~名称|画像認識終了処理|
|~APIバージョン|1|
|~認証タイプ|クライアント認証|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|multipart/form-data|

* 概要 [#jfe13a2c]

画像認識の終了を宣言し、食事を指定する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bu(固定)|string定数|必須|コマンド&br;Bu = ユーザーAPIを呼び出す|
|Category|BY2(固定)|string定数|必須|オペレーションカテゴリー&br;BY2 = バイパスキー|
|Operation|god(固定)|string定数|必須|オペレーション&br;poo =  PUTオペレーション
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|UserAuth|ユーザー認証タイプ|string|必須|userbypass2|
|password|パスワードハッシュ値|hash|必須|cookie値|
|StructData|アップロードデータ|xml|必須|登録するID|
|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]
 mealタグ: ルートノード
  mealidタグ: 食事ID [必須]
  entryidタグ: 画像認識キューエントリーID [必須]


* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|api_rescode|integer|API結果コード|
|api_reason|string|API結果文字列|

** JSONの例 [#i0d756ca]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1,
}
</pre>
}}

** XMLの例 [#c9857f82]
#html{{
<pre class="brush:xml;">
<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
  </response>
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/バイパスキーAPI/画像認識終了処理]]

* バージョン [#o0becc47]

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