データAPI/カスタムJANCODE検索 ※本APIは汎用JANコード検索ではありません。JANコードの他に検索時にレシート名や商品名が必要になります。 API情報 †
概要 †JANCODEによって食品を検索し1件を返却する。当該JANCODEを付与された食品がない場合、商品マスタ名、レシート名で検索を実施し一致の可能性が高い1件を返却する。 アクセス手順 †クエリー †https://(APIサーバー名)/services/api2/(アクセスコード)/search/(カスタムコード)/json/JANCODE,レシート名,商品マスタ名,分類名/?withjancode=1 入力文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。 クエリー (GET) の最大値は 8192 Byte(8KB) とする。 カスタム条件 †カスタム条件は、クエリー文字列としてクエリー末尾に付加する。
数量情報付与ルール †指定されたJANCODEに数量情報がある場合、食品名の末尾に次の書式で追加される。 " [(q)(u)]" (q)=分量:数値 (u)=単位:文字列 単位(u)に使用される可能性のある文字列は、以下から取得する。 https://(APIサーバー名)/services/api2/(アクセスコード)/search/(カスタムコード)/json/unittypes/ 入力文字列ルール †
入力文字列の取り扱い †入力文字列は、半角カンマ(",")で区切られた複数の語によって構成される。 クエリー例 †https://(APIサーバー名)/services/api2/(アクセスコード)/search/(カスタムコード)/json/4901577073670,%EF%BC%B1%EF%BC%B0%E4%BA%BA%E5%8F%82%E3%81%A8%E3%82%AA%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%89%E3%83%AC,%E3%82%AD%E3%83%A6%E3%83%BC%E3%83%94%E3%83%BC%20%E3%81%AB%E3%82%93%E3%81%98%E3%82%93%E3%81%A8%E3%82%AA%E3%83%AC%E3%83%B3%E3%82%B8%E3%83%89%E3%83%AC%E3%83%83%E3%82%B7%E3%83%B3%E3%82%B0,%E8%AA%BF%E5%91%B3%E6%96%99/?withjancode=1 レスポンス †レスポンスコードは200を返し、レスポンスはjson形式である。レスポンスされる食品数の最大値は 1 である。 検索結果が存在しない場合は長さ0の配列が返される。クエリー書式誤り等の場合はレスポンスコード404が返される。 { foods :[ { "name" : 食品名, "yomi" : 食品名読み, "objectid" : オブジェクトID, "unit" : 分量, "stuff_e" : エネルギー, "stuff_p" : たんぱく質, "stuff_f" : 脂質, "stuff_c" : 炭水化物, "..そのほかご契約栄養素" : 栄養素値, "categorytree" : [ 第1階層カテゴリー名, 第2階層カテゴリー名, 第3階層カテゴリー名 ], "subsubattr" : { "gaishoku" : 外食フラグ 0 or 1, "kakou" : 加工食品フラグ 0 or 1, "takeout" : テイクアウトフラグ 0 or 1, }, "shopname" : メーカー名, "jancode" : [ JANCODEの配列 "4902775039833" ], }, { (食品データ) }, : ] } 投入されたJANCODEが次に該当する場合は、配列foodsが存在せず、errcdに事由が設定される。 { errcd :"notfood" } 事由 notfood = 入力が非食品JANCODEと推定される。 事由 invalid = 入力が不正である(JANCODE及び・又はレシート名、商品マスタ名がない、等)または、JANCODEが不正(半角数値でない、等)と推定される。 レスポンス例 †{ "foods": [ { "name": "\u30d5\u30e9\u30f3\u30b9\u30d1\u30f3\u30c1\u30c3\u30d7\u30b9 \u30d9\u30fc\u30b3\u30f3\u30da\u30c3\u30d1\u30fc\u5473(1\u888b38g)(\u304a\u3084\u3064\u30ab\u30f3\u30d1\u30cb\u30fc)", "yomi": "\u3075\u3089\u3093\u3059\u3071\u3093\u3061\u3063\u3077\u3059\u3079\u30fc\u3053\u3093\u307a\u3063\u3071\u30fc\u3042\u3058\u3072\u3068\u3075\u304f\u308d\u3055\u3093\u3058\u3085\u3046\u306f\u3061\u3050\u3089\u3080\u304a\u3084\u3064\u304b\u3093\u3071\u306b\u30fc", "objectid": "FO004627c94e530a370bda2089", "unit": 38, "stuff_e": 187, "stuff_p": 4.3, "stuff_f": 8.4, "stuff_c": 23.5, "stuff_na": 361, "stuff_k": 58.8, "stuff_ca": 10.7, "stuff_mg": 10.2, "stuff_pp": 30.5, "stuff_fe": 0.6, "stuff_zn": 0.3, "stuff_cu": 0.1, "stuff_mn": 0.2, "stuff_va6": 0.2, "stuff_vd": 0, "stuff_ve1": 1.1, "stuff_vk": 13.3, "stuff_vb1": 0, "stuff_vb2": 0, "stuff_vb3": 0.5, "stuff_vb6": 0, "stuff_vb12": 0, "stuff_vb9": 12.9, "stuff_vc": 0, "stuff_fac1": 1, "stuff_fiber": 1, "stuff_fac5": 0.5, "stuff_fac6": 2.9, "selen": 11.1, "chrome": 0.7, "molybdenum": 7.8, "iodine": 0.1, "biotin": 0.9, "categorytree": [ "\u305d\u306e\u4ed6", "\u83d3\u5b50\u985e", "\u30b9\u30ca\u30c3\u30af\u83d3\u5b50" ], "shopsubattr": { "gaishoku": 0, "kakou": 1, "takeout": 0 }, "shopname": "\u304a\u3084\u3064\u30ab\u30f3\u30d1\u30cb\u30fc", "jancode": [ "4902775039833" ] } ] } 特記事項 †本APIの検索では、外食系種別の商品を除外して検索している。 考慮事項 †バージョン †このドキュメントのバージョン情報
|