[[FrontPage]]
&size(24){データAPI/食品文字列検索+};
* API情報 [#q6190828]
|~名称|食品文字列検索+|
|~APIバージョン|1|
|~認証タイプ|なし|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_and.php&br;https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_concatand.php&br;https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_or.php|
|~Method|GET|
* 概要 [#jfe13a2c]
文字列によって食品を検索する。&br;
複数文字列を指定された場合、AND処理、またはOR結合後AND処理、またはOR処理を行う。
* アクセス手順 [#ya59d11f]
** クエリー [#l9016c71]
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_and.php?(検索文字列) &br;
検索文字列は、半角スペースで区切って複数の文字列を指定できる。複数文字列の場合、1番目の文字列で [[データAPI/食品文字列検索]] を実施し、結果のうち、名前(name)に2番目以降の文字列を含むものだけを抽出して返却する。
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_concatand.php?(検索文字列) &br;
検索文字列は、半角スペースで区切って複数の文字列を指定できる。複数文字列の場合、各文字列で [[データAPI/食品文字列検索]] を実施し、結果を全て結合したのち、名前(name)に1番目以降(1番目を含む全ての語)の文字列を含むものだけを抽出して返却する。
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_or.php?(検索文字列) &br;
検索文字列は、半角スペースで区切って複数の文字列を指定できる。複数文字列の場合、各文字列で [[データAPI/食品文字列検索]] を実施し、結果を結合して返却する。
検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。
** クエリー例 [#ea78dac9]
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_and.php?%E3%83%96%E3%83%AD%E3%83%83%E3%82%B3%E3%83%AA%E3%83%BC%20%E3%82%86%E3%81%A7
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_concatand.php?%E3%83%96%E3%83%AD%E3%83%83%E3%82%B3%E3%83%AA%E3%83%BC%20%E3%82%AB%E3%83%AA%E3%83%95%E3%83%A9%E3%83%AF%E3%83%BC
https://(APIサーバー名)/services/api/(アクセスコード)/Static_query_or.php?%E3%83%96%E3%83%AD%E3%83%83%E3%82%B3%E3%83%AA%E3%83%BC%20%E3%82%AB%E3%83%AA%E3%83%95%E3%83%A9%E3%83%AF%E3%83%BC
** レスポンス [#b7e56e30]
レスポンスはXML形式である。
foods: ルートノード
words: 検索語
object: 食品データ
(attr) oid: 食品オブジェクトID
name: 名前
yomi: 名前読み
category: 所属カテゴリー名
shopname: メーカー名
shopsubattr: 商品等フラグ
GAISHOKU: 外食フラグ
KAKOU: 加工品フラグ
TAKEOUT: テイクアウトフラグ
※以下は栄養素コード対応表に従う
stuff_e
unit
purineanimal
tryptophan
carbo
** レスポンス例 [#i994a280]
#html{{
<pre class="brush:xml;">
<?xml version="1.0" encoding="UTF-8"?>
<foods version="1.0">
<words>ブロッコリー ゆで</words>
<object oid="FO29240fd24566d0583eace35c">
<name>ブロッコリー/花序、ゆで</name>
<yomi>ぶろっこりーかじょゆで</yomi>
<stuff_e>11</stuff_e>
<unit>40</unit>
<category>ブロッコリー</category>
<shopname/>
<shopsubattr>
<GAISHOKU>0</GAISHOKU>
<KAKOU>0</KAKOU>
<TAKEOUT>0</TAKEOUT>
</shopsubattr>
<purineanimal>0.0</purineanimal>
<tryptophan>15.2</tryptophan>
<carbo>0.2</carbo>
</object>
</foods>
</pre>
}}
* 考慮事項 [#wa8c2055]
本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることが望ましい。
* バージョン [#o0becc47]
このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|