データAPI/MMメニュー詳細情報取得 の変更点

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

#author("2020-03-29T09:27:31+09:00","","")
[[FrontPage]]

&size(24){データAPI/MMメニュー詳細情報取得};

* API情報 [#q6190828]

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

* 概要 [#jfe13a2c]

指定されたオブジェクトIDのMMメニュー食品の詳細情報を取得する。&br;
MMメニュー食品の詳細情報は、エコノミーAPI用管理ツールで設定する。

* アクセス手順 [#ya59d11f]

** クエリー [#l9016c71]

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

** クエリー例 [#ea78dac9]

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

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

 {
    "override": {
        "comment": "新鮮野菜シリーズ",
        "name": "新鮮キャベツ"
    },
    "relation": [
        {
            "objectid": "FO035969864782e6842382ad64",
            "comment": "ヒレで低カロリーに。",
            "name": "手作りトンカツ",
            "o_comment": "付け合わせにキャベツがオススメ。",
            "o_name": "とんかつ(1枚)"
        }
    ],
    "original": {
        "objectid": "FO30c210f05ca1c173183f3ee8",
        "name": "キャベツ"
    }
 }
 
 override : 独自に設定した食品名及びコメント
  override.name : 独自食品名
  override.comment : 食品についてのコメント文字列
 relation : 対象食品に関連付けした食品の情報
  relation[n].objectid : 関連付けされた食品のオブジェクトID
  relation[n].name : 関連付けされた食品の食品名
  relation[n].o_name : 関連付けされた食品の正式名(もしあれば)
  relation[n].comment : 関連付けされた食品のコメント(override.commentに相当)(もしあれば)
  relation[n].o_comment : 関連付けへのコメント(もしあれば)
 original : 対象食品の正式名等の情報
  original.objectid : 食品のオブジェクトID
  original.name : 食品の正式名

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

#html{{
<pre class="brush:xml;">
{
    &quot;override&quot;: {
        &quot;comment&quot;: &quot;\u65b0\u9bae\u91ce\u83dc\u30b7\u30ea\u30fc\u30ba&quot;,
        &quot;name&quot;: &quot;\u65b0\u9bae\u30ad\u30e3\u30d9\u30c4&quot;
    },
    &quot;relation&quot;: [
        {
            &quot;objectid&quot;: &quot;FO035969864782e6842382ad64&quot;,
            &quot;comment&quot;: &quot;\u30d2\u30ec\u3067\u4f4e\u30ab\u30ed\u30ea\u30fc\u306b\u3002&quot;,
            &quot;name&quot;: &quot;\u624b\u4f5c\u308a\u30c8\u30f3\u30ab\u30c4&quot;,
            &quot;o_comment&quot;: &quot;\u4ed8\u3051\u5408\u308f\u305b\u306b\u30ad\u30e3\u30d9\u30c4\u304c\u30aa\u30b9\u30b9\u30e1\u3002&quot;,
            &quot;o_name&quot;: &quot;\u3068\u3093\u304b\u3064(1\u679a)&quot;
        }
    ],
    &quot;original&quot;: {
        &quot;objectid&quot;: &quot;FO30c210f05ca1c173183f3ee8&quot;,
        &quot;name&quot;: &quot;\u30ad\u30e3\u30d9\u30c4&quot;
    }
}</pre>
}}

* 考慮事項 [#wa8c2055]

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

* バージョン [#o0becc47]

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