データAPI/食品詳細情報取得 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• データAPI/食品詳細情報取得 へ行く。

#author("2021-02-12T15:09:23+09:00","","")
[[FrontPage]]

&size(24){データAPI/食品詳細情報取得};

※オプションサービスとなります

* API情報 [#q6190828]

|~名称|食品詳細情報取得|
|~APIバージョン|2|
|~認証タイプ|なし|
|~URL|&br;https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/(オブジェクトID)/|
|~Method|GET|
|~データ更新頻度目安|1日|

* 概要 [#jfe13a2c]

指定されたオブジェクトIDの食品の詳細情報を取得する。&br;

* アクセス手順 [#ya59d11f]

** クエリー [#l9016c71]

https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/(オブジェクトID)/ &br;
(オブジェクトID) の食品詳細情報を返却する。

** クエリー例 [#ea78dac9]

 https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/FO30c210f05ca1c173183f3ee8/
 
** レスポンス [#b7e56e30]

レスポンスコードは200を返し、レスポンスはjson形式である。&br;
指定されたオブジェクトIDの詳細情報が存在しない場合、又は食品でない場合は、空のオブジェクトが返される。クエリー書式誤り等の場合はレスポンスコード404が返される。&br;

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

#html{{
<pre class="brush:xml;">
{
  &quot;name&quot;: &quot;卵焼き(2切れ)&quot;,
  &quot;yomi&quot;: &quot;たまごやきふたきれ&quot;,
  &quot;objectid&quot;: &quot;FO9a58f57646c9455b3ecac928&quot;,
  &quot;unit&quot;: 84.1,
  &quot;stuff_e&quot;: 103.8,
  &quot;stuff_p&quot;: 6.6,
  &quot;stuff_f&quot;: 6.3,
  &quot;stuff_c&quot;: 4.3,
  &quot;stuff_fiber&quot;: 0,
  &quot;carbo&quot;: 4.3,
  &quot;categorytree&quot;: [
    &quot;和食&quot;,
    &quot;単品&quot;,
    &quot;副菜・汁物&quot;
  ],
  &quot;shopname&quot;: &quot;&quot;,
  &quot;elements&quot;: [
    {
      &quot;elementid&quot;: &quot;FO6453aaa746d3086833cbb5c2&quot;,
      &quot;elementunit&quot;: 50
    },
    {
      &quot;elementid&quot;: &quot;FO90d07a4646d307d4789e8d73&quot;,
      &quot;elementunit&quot;: 4
    },
    {
      &quot;elementid&quot;: &quot;FOb668820346d308702d4cabbd&quot;,
      &quot;elementunit&quot;: 2
    }
  ]
}</pre>
}}

* 考慮事項 [#wa8c2055]

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

* バージョン [#o0becc47]

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