データAPI/基本素材リスト文字列検索 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• データAPI/基本素材リスト文字列検索 へ行く。

#author("2020-03-30T06:55:10+09:00","","")
[[FrontPage]]

&size(24){データAPI/基本素材リスト文字列検索};

* API情報 [#q6190828]

|~名称|基本素材リスト文字列検索|
|~APIバージョン|2|
|~認証タイプ|なし|
|~URL|https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/検索語/ &br;https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/検索語/開始位置/表示個数/|
|~Method|GET|
|~データ更新頻度目安|1日|

* 概要 [#jfe13a2c]

文字列によって基本素材リストを検索する。&br;

* アクセス手順 [#ya59d11f]

** クエリー [#l9016c71]

https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/(検索文字列)/ &br;
(検索文字列) で検索した結果を返却する。

https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/(検索文字列)/(開始位置)/(表示個数)/ &br;
(検索文字列) で検索した結果のうち、0から始まるインデックスの(開始位置)番目から、(表示個数)個のアイテムを返却する。

検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。


** 入力される検索文字列の取り扱い [#u55567aa]

入力された検索文字列は、全部分が採用され、切り捨てはない。&br;
半角スペース(" ")で区切って複数の検索語を列挙した場合、AND検索となる。

** クエリー例 [#ea78dac9]

 https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3%20%E9%87%8E%E8%8F%9C/
 
** レスポンス [#b7e56e30]

レスポンスコードは200を返し、レスポンスはjson形式である。レスポンスされる食品数の最大値は 500 である。
検索結果が存在しない場合は長さ0の配列が返される。クエリー書式誤り等の場合はレスポンスコード404が返される。

※以下の内容はサンプルであり、食品栄養データライセンスご契約内容によって異なります。

 {
  "foods": [
    {
      "name": 食品名,
      "yomi": 食品名よみ,
      "objectid": オブジェクトID,
      "unit": 分量,
      "stuff_e": カロリー,
      :
      "categorytree": [
        第1階層カテゴリー名,
        第2階層カテゴリー名,
        第3階層カテゴリー名,
      ],
      "shopname": メーカー名,
      "elements": [
        {
          "elementid": 構成食材オブジェクトID,
          "elementunit": 構成食材分量
        },
        :
      ]
    },
    {
      (食品データ)
    },
    :
  ],
 }

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

※以下の内容はサンプルであり、食品栄養データライセンスご契約内容によって異なります。

#html{{
<pre class="brush:xml;">
{
  &quot;foods&quot;: [
    {
      &quot;name&quot;: &quot;トマトピューレー(100g)&quot;,
      &quot;yomi&quot;: &quot;とまとぴゅーれー ひゃくぐらむ&quot;,
      &quot;objectid&quot;: &quot;FOb656cfb75e7be7af465da188&quot;,
      &quot;unit&quot;: 100,
      &quot;stuff_e&quot;: 41,
      &quot;stuff_p&quot;: 1.9,
      &quot;stuff_f&quot;: 0.1,
      &quot;stuff_c&quot;: 9.9,
      &quot;stuff_fiber&quot;: 1.8,
      &quot;carbo&quot;: 8.1,
      &quot;categorytree&quot;: [
        &quot;その他&quot;,
        &quot;基本素材&quot;,
        &quot;調味料&quot;
      ],
      &quot;shopname&quot;: &quot;&quot;,
      &quot;elements&quot;: [
        {
          &quot;elementid&quot;: &quot;FOe218918346d3088b1792e8f6&quot;,
          &quot;elementunit&quot;: 100
        }
      ]
    },
 ]
}</pre>
}}

* 考慮事項 [#wa8c2055]

本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。

* バージョン [#o0becc47]

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