食品流通信息化質(zhì)量管理體系建設(shè)規(guī)范

1食品配送企業(yè)食品追溯系統(tǒng)數(shù)據(jù)接口規(guī)范本標(biāo)準(zhǔn)規(guī)定了食品配送企業(yè)食品追溯系統(tǒng)數(shù)據(jù)接口的術(shù)語和定義、數(shù)據(jù)接口及認(rèn)證方式、數(shù)據(jù)接口說明以及接口驗(yàn)收標(biāo)準(zhǔn)。本標(biāo)準(zhǔn)適用于食品配送企業(yè)食品追溯系統(tǒng)的接入與應(yīng)用，也可用于指導(dǎo)食品配送企業(yè)食品追溯系統(tǒng)的開發(fā)。2規(guī)范性引用文件下列文件對于本文件的應(yīng)用是必不可少的。凡是注日期的引用文件，僅所注日期的版本適用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T1.1-2009標(biāo)準(zhǔn)的結(jié)構(gòu)和編寫GB/T2659-2000世界各國和地區(qū)名稱代碼GB/T7635.1-2002T全國主要產(chǎn)品分類與代碼3術(shù)語和定義下列術(shù)語和定義適用于本文件。3.1數(shù)據(jù)接口Datainterface計算機(jī)軟件系統(tǒng)之間傳送數(shù)據(jù)、交換信息的接口，以電子文件的形式實(shí)現(xiàn)。3.2食品配送企業(yè)食品追溯系統(tǒng)DataInterfaceSpecificationForFoodTraceabilitySystemOfFoodDistributionEnterprises“食品配送企業(yè)食品追溯系統(tǒng)”是一個能夠連接食品生產(chǎn)、檢驗(yàn)、監(jiān)管、配送和消費(fèi)各個環(huán)節(jié)，讓消費(fèi)者了解符合衛(wèi)生安全的生產(chǎn)和流通過程，提高消費(fèi)者放心程度的信息管理系統(tǒng)。4縮略語下列縮略語適用于本文件。HTTP：超文本傳輸協(xié)議（HyperTextTransferProtocol）JSON：JavaScript對象標(biāo)記語言（JavaScriptObjectNotation）2T/GDFCA019—20195數(shù)據(jù)接口及認(rèn)證方式5.1數(shù)據(jù)接口范圍及內(nèi)容食品配送企業(yè)食品追溯系統(tǒng)應(yīng)提供一系列的接口，應(yīng)包括且不限于如圖所示功能：圖1食品配送企業(yè)食品追溯系統(tǒng)接口范圍5.2認(rèn)證方式本系統(tǒng)中，接口使用方在調(diào)用數(shù)據(jù)接口前必須經(jīng)過認(rèn)證，接口提供方需提供認(rèn)證接口給接口使用方進(jìn)行認(rèn)證操作。接口提供方為每個接口使用方分配應(yīng)用標(biāo)識和憑據(jù)（authID和authKey接口使用方調(diào)用認(rèn)證接口，通過應(yīng)用標(biāo)識和憑據(jù)獲取具有一定時效性的有效令牌，之后調(diào)用數(shù)據(jù)接口均需帶上該令牌。6數(shù)據(jù)接口說明6.1數(shù)據(jù)格式本系統(tǒng)需采用JSON作為系統(tǒng)間的數(shù)據(jù)傳輸格式，調(diào)用接口時請求數(shù)據(jù)和返回數(shù)據(jù)均采用JSON格式。系統(tǒng)中傳輸?shù)臄?shù)據(jù)格式如表1所示，在定義參數(shù)類型時只能從這六種類型中選取。表1數(shù)據(jù)傳輸格式類型格式示例字符字符串userName:“張三”數(shù)字整型、浮點(diǎn)型YYYY-MM-DDbirthday:“1983-12-05”YYYY-MM-DDHH:mm:sscreateTime:“1983-12-0513:05:00”數(shù)組列表data：[{11,12},{21,22}]布爾型布爾型isDeleted:“false”6.2企業(yè)信息查詢接口6.2.1概述主要功能是獲取企業(yè)信息。6.2.2企業(yè)信息查詢接口函數(shù)a)接口說明：獲取企業(yè)信息b)接口地址：http://serverurl/eniotis/enterpriseInfo.do?action=listc)請求方式：post。a)請求參數(shù)列表：見表2。表2查詢企業(yè)信息列表接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型enterpriseName否企業(yè)名稱字符串linkMan否聯(lián)系人字符串linkPhone否聯(lián)系電話字符串enterpriseType否企業(yè)類型字符串b)返回參數(shù)說明：見表3。b)表3查詢企業(yè)信息列表接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回非0數(shù)字Message狀態(tài)說明數(shù)字dataPage頁碼數(shù)字Total返回記錄數(shù)數(shù)字Records總記錄數(shù)數(shù)字rows數(shù)字enterpriseType企業(yè)類型字符串enterpriseName企業(yè)名稱字符串manager聯(lián)系人字符串managerPhone聯(lián)系電話字符串remark備注字符串c)返回參數(shù)示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","id":"245461234564546","enterpriseType":"企業(yè)類型","enterpriseName":"企業(yè)名稱","manager":"聯(lián)系人","managerPhone":"聯(lián)系電話","remark":"備注"}}6.3新增或修改企業(yè)信息查詢接口6.3.1概述主要功能是新增或修改企業(yè)信息。4T/GDFCA019—20196.3.2新增或修改企業(yè)信息接口函數(shù)d)接口說明：新增或修改企業(yè)信息e)接口地址：http://serverurl/eniotis/enterpriseInfo.do?action=saveEnterpriseInfof)請求方式：postd)請求參數(shù)列表：見表4。表4新增或修改企業(yè)信息接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型否數(shù)字enterpriseName否企業(yè)名稱字符串creditCode是統(tǒng)一信用代碼字符串enterpriseType否企業(yè)類型字符串manager否聯(lián)系人字符串managerPhone否聯(lián)系電話字符串enterpriseLegaler否企業(yè)法人字符串legalerPhone否法人電話字符串a(chǎn)ddress否企業(yè)地址字符串返回參數(shù)說明：見表5。表5新增或修改企業(yè)信息接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回非0數(shù)字Message狀態(tài)說明數(shù)字data數(shù)字f)返回參數(shù)示列：{"code":"0","message":"success",}}6.4產(chǎn)品信息列表查詢接口6.4.1概述主要功能是獲取產(chǎn)品信息列表。6.4.2產(chǎn)品信息列表查詢接口函數(shù)g)接口說明：查詢產(chǎn)品信息列表h)接口地址：http://serverurl/eniotis/productInfo.do?action=listi)請求方式：post。g)請求參數(shù)列表：見表6。表6查詢產(chǎn)品信息列表接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型productName否產(chǎn)品名稱字符串barCode否商品條碼字符串rows否每頁多少條數(shù)字page否第幾頁數(shù)字h)返回參數(shù)說明：見表7。h)表7查詢產(chǎn)品信息列表接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回數(shù)字Message狀態(tài)說明數(shù)字dataPage頁碼數(shù)字Total返回記錄數(shù)數(shù)字Records總記錄數(shù)數(shù)字rows數(shù)字productName產(chǎn)品名稱字符串barCode商品條形碼字符串productTypeName產(chǎn)品分類字符串brand字符串specifications產(chǎn)品規(guī)格字符串specificationUnit規(guī)格單位字符串i)返回參數(shù)示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","productName":"產(chǎn)品名稱","barCode":"商品條形碼","productTypeName":"產(chǎn)品分類","specifications":"產(chǎn)品規(guī)格","specificationUnit":"規(guī)格單位"6T/GDFCA019—2019}}6.5批次信息列表查詢接口6.5.1概述主要功能是獲取批次信息列表。6.5.2批次信息列表查詢接口函數(shù)j)接口說明：查詢批次信息列表k)接口地址：http://serverurl/eniotis/productInfo.do?action=listl)請求方式：post。j)請求參數(shù)列表：見表8。表8查詢批次信息列表接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型batchCode否批次號字符串productName否商品名稱字符串k)返回參數(shù)說明：見表9。k)表9查詢批次信息列表接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回數(shù)字Message狀態(tài)說明數(shù)字dataPage頁碼數(shù)字Total返回記錄數(shù)數(shù)字Records總記錄數(shù)數(shù)字rows數(shù)字batchCode批次號字符串productName產(chǎn)品名稱字符串number數(shù)量字符串unitName單位名稱字符串formState啟用字符串l)返回參數(shù)示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","batchCode":"批次號","productName":"產(chǎn)品名稱","number":"數(shù)量","unitName":"單位名稱","formState":"狀態(tài)"}}6.6裝箱事件接口6.6.1概述主要功能是裝箱事件操作。6.6.2裝箱事件接口函數(shù)m)接口說明：裝箱事件n)接口地址：http://serverurl/eniotis/packageevent.do?action=packageEvento)請求方式：post。f)請求參數(shù)列表：見表10。表10裝箱事件接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型packageInfoJson是{isUpdate;//BooleanboxCode;//箱碼traceCodeList[{traceCode;//被裝物品碼}字符串返回參數(shù)說明：見表11。參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回數(shù)字Message狀態(tài)說明數(shù)字h)返回參數(shù)示列：{"code":"0","message":"success"8T/GDFCA019—2019}6.7拆箱事件接口6.7.1概述主要功能是拆箱事件操作。6.7.2拆箱事件接口函數(shù)p)接口說明：拆箱事件q)接口地址：http://serverurl/eniotis/packageevent.do?action=unpackageEventr)請求方式：post。j)請求參數(shù)列表：見表12。表12拆箱事件接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型boxCode是箱碼字符串k)返回參數(shù)說明：見表13。k)表13拆箱事件接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回數(shù)字Message狀態(tài)說明數(shù)字l)返回參數(shù)示列：{"code":"0","message":"success"}m)6.8成品退庫和原料退庫列表接口6.8.1概述主要功能是查詢成品退庫和原料退庫列表。6.8.2成品退庫和原料退庫列表接口函數(shù)s)接口說明：成品退庫和原料退庫列表t)接口地址：http://serverurl/eniotis/formInfo.do?action=listReturnOrderu)請求方式：postn)請求參數(shù)列表：見表14。表14成品退庫和原料退庫列表接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型formNumber否訂單號數(shù)字enterpriseName否供應(yīng)商/經(jīng)銷商字符串productName是原料/成品名稱字符串batch否批次號字符串formType否MaterialCancel("原料退庫"),ProductCancel("成品退庫字符串o)返回參數(shù)說明：見表15。o)表15成品退庫和原料退庫列表接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回非0數(shù)字Message狀態(tài)說明數(shù)字dataPage頁碼數(shù)字Total返回記錄數(shù)數(shù)字Records總記錄數(shù)數(shù)字rows數(shù)字formDate退庫日期字符串formNumber訂單號字符串enterpriseName供應(yīng)商/經(jīng)銷商名稱字符串productName原料/成名名稱字符串p)返回參數(shù)示列：{"code":"0","message":"success","formDate":"退庫日期"，"formNumber":"訂單號"，"enterpriseName":"供應(yīng)商/經(jīng)銷商名稱"，"productName":"原料/成名名稱"}}6.9召回訂單列表接口6.9.1概述主要功能是查詢召回訂單列表。6.9.2召回訂單列表接口函數(shù)v)接口說明：召回訂單列表T/GDFCA019—2019w)接口地址：http://serverurl/eniotis/recallFormInfo.do?action=listx)請求方式：postq)請求參數(shù)列表：見表16。表16召回訂單列表接口請求參數(shù)列表參數(shù)是否必填說明數(shù)據(jù)類型productName否成品名稱字符串batch否批次號字符串r)返回參數(shù)說明：見表17。r)表17召回訂單列表接口返回參數(shù)列表參數(shù)說明數(shù)據(jù)類型Code狀態(tài)碼：成功返回0，失敗返回非0數(shù)字Message狀態(tài)說明數(shù)字dataPage頁碼數(shù)字Total返回記錄數(shù)數(shù)字Records總記錄數(shù)數(shù)字rows數(shù)字productName商品名稱字符串batch批次號字符串produceDate生產(chǎn)日期字符串formStateHasWithDraw("已撤回"),NormalOrder("正常")字符串expiryDate有效期字符串recallNumber召回數(shù)量字符串reason原因字符串s)返回參數(shù)示列