データAPI/食品カテゴリー検索 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• データAPI/食品カテゴリー検索 へ行く。

[[FrontPage]]

&size(24){データAPI/食品カテゴリー検索};

* API情報 [#q6190828]

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

* 概要 [#jfe13a2c]

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


* アクセス手順 [#ya59d11f]

** クエリー [#l9016c71]

*** 最上位階層を取得する [#g79f6dc0]
https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/

*** 指定カテゴリーを取得する [#qbce2918]
https://(APIサーバー名)/services/api/(アクセスコード)/CATEGORY/(食品カテゴリーID).xml &br;

*** 特殊な食品カテゴリーID [#a0fa4733]

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


** レスポンス [#p4fcc6c3]

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

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

** クエリーとレスポンスの例 [#ea78dac9]

*** 中間階層カテゴリーに対するクエリー例 [#qe75621e]
 https://(APIサーバー名)/api/(アクセスコード)/CATEGORY/FT665b7cb246d307c166100d66.xml

*** 中間階層カテゴリーに対するレスポンス例 [#y5750bc0]

#html{{
 <pre class="brush:xml;">
}}
#htmlinsert(samxml_mobadaiapi_foodcatsearch1.xml)
#html{{
 </pre>
}}

*** 末端階層カテゴリーに対するクエリー例 [#f53b5f90]
 https://(APIサーバー名)/api/(アクセスコード)/CATEGORY/FT3f5a27b246d30868214cb709.xml

*** 末端階層カテゴリーに対するレスポンス例 [#cf83f77a]

#html{{
 <pre class="brush:xml;">
}}
#htmlinsert(samxml_mobadaiapi_foodcatsearch2.xml)
#html{{
 </pre>
}}


* 考慮事項 [#n77d1fb7]

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

* バージョン [#o0becc47]

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