データAPI/食品文字列検索 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• データAPI/食品文字列検索 へ行く。

[[FrontPage]]

&size(24){データAPI/食品文字列検索};

* API情報 [#q6190828]

|~名称|食品文字列検索|
|~APIバージョン|1|
|~認証タイプ|なし|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/SEARCH/|
|~Method|GET|
|~データ更新頻度目安|2週間|

* 概要 [#jfe13a2c]

文字列によって食品を検索する

* アクセス手順 [#ya59d11f]

** クエリー [#l9016c71]

https://(APIサーバー名)/services/api/(アクセスコード)/SEARCH/(検索文字列).xml &br;
検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。

** クエリー例 [#ea78dac9]

 https://(APIサーバー名)/services/api/(アクセスコード)/SEARCH/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3.xml


** レスポンス [#b7e56e30]

レスポンスはXML形式である。

 foods: ルートノード
   words: 検索語
   count: 最大結果数
   object: 食品データ
    (attr) oid: 食品オブジェクトID
    name: 名前
    yomi: 名前読み
    category: 所属カテゴリー名
    shopname: メーカー名
    shopsubattr: 商品等フラグ
     GAISHOKU: 外食フラグ
     KAKOU: 加工品フラグ
     TAKEOUT: テイクアウトフラグ
    ※以下は栄養素コード対応表に従う
    stuff_e
    unit
    purineanimal
    tryptophan
    carbo

** レスポンス例 [#i994a280]

#html{{
<pre class="brush:xml;">
 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 &lt;foods version="1.0"&gt;
   &lt;words&gt;ラーメン&lt;/words&gt;
   &lt;count&gt;100&lt;/count&gt;
   &lt;object oid="FO29240fd24566d0583eace35c"&gt;
     &lt;name&gt;醤油ラーメン&lt;/name&gt;
     &lt;yomi&gt;しょうゆらーめん&lt;/yomi&gt;
     &lt;stuff_e&gt;534&lt;/stuff_e&gt;
     &lt;unit&gt;693&lt;/unit&gt;
     &lt;category&gt;米・麺&lt;/category&gt;
     &lt;shopname/&gt;
     &lt;shopsubattr&gt;
       &lt;GAISHOKU&gt;0&lt;/GAISHOKU&gt;
       &lt;KAKOU&gt;0&lt;/KAKOU&gt;
       &lt;TAKEOUT&gt;0&lt;/TAKEOUT&gt;
     &lt;/shopsubattr&gt;
     &lt;purineanimal&gt;0.0&lt;/purineanimal&gt;
     &lt;tryptophan&gt;93.5&lt;/tryptophan&gt;
     &lt;carbo&gt;68.0&lt;/carbo&gt;
   &lt;/object&gt;
 &lt;/foods&gt;
</pre>
}}

* 考慮事項 [#wa8c2055]

本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることが望ましい。

* バージョン [#o0becc47]

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