データAPI/食品カテゴリー検索

FrontPage

データAPI/食品カテゴリー検索

API情報†

概要†

食品カテゴリーを検索する。
配下に子カテゴリーが存在すれば、そのカテゴリー情報を返す。
配下に食品が存在すれば、食品を最大100件まで返す。

アクセス手順†

クエリー†

最上位階層を取得する†

https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/

指定カテゴリーを取得する†

https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/(食品カテゴリーID).xml

特殊な食品カテゴリーID†

FT00000000000000000000000X: 最上位カテゴリーを意味する。
https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/ と
https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/FT00000000000000000000000X.xml は
同じ結果を返却する。

レスポンス†

category: ルートノード
 nodeid: このカテゴリーノードの食品カテゴリーID
 level: このカテゴリーノードの属する階層
 position: このカテゴリーノードを含み、ここから最上位階層までのカテゴリー情報
  node: カテゴリーノード情報
   nodeid: 食品カテゴリーID
   name: 食品カテゴリーの名称
   level: 食品カテゴリーの階層
 subordinates: このカテゴリーノードの配下に位置するカテゴリーの情報
  node: カテゴリーノード情報
   nodeid: 食品カテゴリーID
   name: 食品カテゴリーの名称
 foods: このカテゴリーノードの配下に位置する食品の情報
  (foods内の各タグは、データAPI/食品文字列検索 の書式に準ずる)
  (但し、以下のタグは含まれない。)
  ( category )

foods内の各タグは、データAPI/食品文字列検索 の書式に準ずる

クエリーとレスポンスの例†

中間階層カテゴリーに対するクエリー例†

https://(APIサーバー名)/api/(アクセスコード)/CATEGORY/FT665b7cb246d307c166100d66.xml

中間階層カテゴリーに対するレスポンス例†

<?xml version="1.0" encoding="UTF-8" ?>
<category version="1.0">
 <nodeid>FT665b7cb246d307c166100d66</nodeid>
 <level>1</level>
 <position>
   <node>
     <nodeid>FT665b7cb246d307c166100d66</nodeid>
     <name>食品成分</name>
     <level>1</level>
   </node>
 </position>
 <subordinates>
   <node>
     <nodeid>FTaefc50b246d307cf0b3c6d5d</nodeid>
     <name>いも及びでん粉類</name>
   </node>
   <node>
     <nodeid>FT4993575046d3081b0a1dbb8b</nodeid>
     <name>きのこ類</name>
   </node>
 </subordinates>
 <foods/>
</category>

 

末端階層カテゴリーに対するクエリー例†

https://(APIサーバー名)/api/(アクセスコード)/CATEGORY/FT3f5a27b246d30868214cb709.xml

末端階層カテゴリーに対するレスポンス例†

<?xml version="1.0" encoding="UTF-8" ?>
<category version="1.0">
  <nodeid>FT3f5a27b246d30868214cb709</nodeid>
  <level>3</level>
  <position>
    <node>
      <nodeid>FT3f5a27b246d30868214cb709</nodeid>
      <name>鶏卵類</name>
      <level>3</level>
    </node>
    <node>
      <nodeid>FTe416e89846d308686384c8fe</nodeid>
      <name>卵類</name>
      <level>2</level>
    </node>
    <node>
      <nodeid>FT665b7cb246d307c166100d66</nodeid>
      <name>食品成分</name>
      <level>1</level>
    </node>
  </position>
  <subordinates/>
  <foods>
    <object oid="FO4832647346d3086a62541395">
      <name>だし巻きたまご(一切れ)</name>
      <yomi>だしまきたまごひときれ</yomi>
      <stuff_e>44</stuff_e>
      <unit>34</unit>
      <update>2012/03/07 14:07:51</update>
      <shopname/>
      <shopsubattr>
        <GAISHOKU>0</GAISHOKU>
        <KAKOU>0</KAKOU>
        <TAKEOUT>0</TAKEOUT>
      </shopsubattr>
      <stuff_nacl>0.4</stuff_nacl>
      <stuff_p>3.8</stuff_p>
      <stuff_f>3.1</stuff_f>
      <stuff_c>0.2</stuff_c>
      <stuff_fiber>0.0</stuff_fiber>
      <purineanimal>0.0</purineanimal>
      <tryptophan>0.0</tryptophan>
      <carbo>0.2</carbo>
    </object>
  </foods>
</category>

 

考慮事項†

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

バージョン†

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

目次

• トップページ
• APIを使用する
• 各APIの詳細
• サンプルソース