データAPI/食品動的文字列検索

API情報†

名称	食品動的文字列検索
APIバージョン	1
認証タイプ	なし
URL	https://(APIサーバー名)/services/api/(アクセスコード)/String_query.php
Method	GET

↑

概要†

文字列によって食品を検索する。
検索処理は動的に実施される。

↑

アクセス手順†

↑

クエリー†

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

↑

クエリー例†

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

↑

レスポンス†

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

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

↑

レスポンス例†

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

↑

考慮事項†

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

↑

バージョン†

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

Version	1
Revision	1
Editor	west