食品安全电子追溯数据目录服务数据接口规范

1食品安全电子追溯数据目录服务数据接口规范本标准规定了食品安全电子追溯数据目录服务的功能要求、数据接口。本标准适用于食品安全电子追溯数据目录服务的接口实现。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB12904商品条码零售商品编码与条码表示DB32/TXXXX-2018食品安全电子追溯标识解析服务数据接口规范RFC2616超文本传输协议1.1(Hypertexttransferprotocol--HTTP/1.1)RFC4627JSON格式定义(Theapplication/JSONmediatypeforjavascriptobjectnotation)RFC4825可扩展标记语言配置接入协议(Theextensiblemarkuplanguage(XML)configurationaccessprotocol(XCAP))3术语和定义下列术语和定义适用于本文件。3.1数据目录服务datacatalogservice以物品的追溯标识为索引建立物品所流经的信息查询服务器URL地址列表的过程。3.2网元networkelement由软硬件共同组成的能实现网络中的一种或多种逻辑功能的逻辑单元。3.3IRS网元identificationresolutionservicenetworkelement提供追溯标识注册和追溯标识解析服务的网元。3.4IQS网元informationqueryservicenetworkelement提供可视化追溯信息查询服务的网元。3.52DB32/TXXXX—2018DCS网元datacatalogservicenetworkelement以追溯标识为单位提供追溯路径的建立和查询服务的网元。3.6追溯代理traceabilityproxy以用户发起的HTTP追溯查询请求为触发，代替追溯用户调用IRS,DCS和IQS网元的多个接口完成追溯查询逻辑功能的网元。3.7EU网元endusernetworkelement终端用户所使用的具备追溯查询能力的软件系统的统称。3.8CU网元captureunitnetworkelement负责采集主数据、交易数据和事件数据并提交到IQS网元，完成数据采集功能的网元。3.9SP网元supervisorplatformnetworkelement接收IQS网元上报的追溯数据，支撑政府监管人员利用追溯数据开展对企业监管的网元。4缩略语下列缩略语适用于本文件。CU：捕获单元(CaptureUnit)DNS：域名服务(DomainNameService)DCS：数据目录服务(DataCatalogService)EU：终端用户(EndUser)GTIN：全球贸易项目代码(GlobalTradeItemNumber)IQS：信息查询服务(InformationQueryService)IRS：标识解析服务(IdentificationResolutionService)JSON：JS对象标记(JavaScriptObjectNotation)RFID：射频识别(RadioFrequencyIdentification)SP：监管平台(SupervisorPlatform)URL：统一资源定位符(UniformResourceLocator)URN：统一资源名称(UniformResourceName)XML：可扩展标记语言(ExtensibleMarkupLanguage)5功能要求5.1网元交互5.1.1总则3食品安全电子追溯系统应由企业平台、监管平台和查询平台组成。食品安全电子追溯系统的系统架构见DB32/TXXXX。DCS网元应按归属地管理的原则进行业务管理，部署在归属地生产企业的IQS网元应向负责管理归属地业务的DCS网元发起标识注册和事件登记。DCS网元应将本地区IQS网元注册的物品追溯标识同步向IRS网元发起注册。DCS网元归属地管理架构图见图1。图1DCS网元归属地管理架构图5.1.2网元要求IRS网元应对外提供追溯标识注册和追溯标识解析服务。DCS网元应以追溯标识为单位提供追溯路径的建立和查询的服务。DCS网元应以追溯标识为标识确保物品的可追溯性。IQS网元应提供追溯信息捕获、查询服务和数据上报服务的功能。CU网元应通过条码识读设备和RFID读写器等数据采集设备采集一维码、二维码、RFID标签等信息的功能。EU网元功能应在信息终端设备上实现；EU网元应向用户提供追溯的交互式人机界面。SP网元应部署在监管部门的服务器系统上，SP网元应实现支撑利用追溯数据开展对企业的监管功能。追溯代理应以用户发起的追溯请求为触发，代替用户完成追溯系统的内部业务处理。5.2基本服务功能DCS网元应提供但不限于以下功能：a)追溯标识注册功能；b)追溯事件登记功能；c)追溯信息查询服务。6数据接口6.1基本要求4DB32/TXXXX—2018食品安全电子追溯系统的各个网元之间应通过Internet公共以太网接口互联互通。各网元的物理接口上承载的协议栈应为HTTP或HTTPS协议栈，数据接口应使用基于HTTP/HTTPS协议的JSON格式的消息体传输数据。DCS网元和其它各个网元之间应通过本标准规定的数据接口进行消息交互，实现DCS网元的功能。这些数据接口包括：a)DCS标识管理接口；b)DCS事件登记接口；c)DCS查询接口。6.2接口原语基于服务的方式定义数据接口的使用方法。服务响应流程使用了“请求-Request”“指示-Indication”“响应-Response”“确认-Confirm”四条服务原语，原语的顺序见图2。图2服务响应流程DCS标识管理接口应包括：a)DCS标识注册接口；b)DCS标识更新接口；c)DCS标识删除接口。DCS事件登记接口应包括：a)DCS主数据登记接口；b)DCS事件登记接口。DCS查询接口只包括DCS追溯信息查询接口的一个接口。6.3数据类型DCS网元接口中所使用到的数据类型见表1。5表1数据类型说明每一项均为一个子数据项，子数据项编码方式与父6.4调用方式6.4.1请求请求接口应基于HTTP协议，发送的HTTP请求应符合RFC2616的规定。请求接口应使用Get或者Post方法调用目录服务接口。调用方应将请求参数按照消息格式用JSON封装后，封装在HTTP的Request消息的Body中发送出去。6.4.2响应请求接口调用成功后，DCS网元应以RFC4825中规定的XML或RFC4627中规定的JSON格式将处理结果放置在HTTP的Response消息的Body中，返回给调用者。6.5参数要求6.5.1DCS标识注册接口接口描述部署在食品生产企业的IQS通过可通过DCS标识注册接口调用DCS网元的标识注册服务。该接口调用方向应为从IQS网元到DCS网元，接口调用方法应为HTTPPost；该接口示例参见附录B.1。接口参数该接口名称为DCS_IDList_Reg，DCS标识注册请求接口参数见表2，DCS标识注册响应接口参数见表2DCS标识注册请求接口参数是是是是6DB32/TXXXX—2018表3DCS标识注册响应接口参数返回值，返回注册结果。参数值规定是6.5.2DCS标识更新接口接口描述IQS网元应通过DCS标识更新接口实现对指定标识信息的修改。该接口调用方向为从IQS网元到DCS网元，该接口调用方法为HTTPPost；该接口示例参见附录B.2。接口参数该接口名称为DCS_ID_Upd，DCS标识更新请求接口参数见表4，DCS标识更新响应接口参数见表5。表4DCS标识更新请求接口参数是是是是表5DCS标识更新响应接口参数是6.5.3DCS标识删除接口接口描述IQS网元应通过DCS标识删除接口实现对指定标识追溯信息的删除。接口调用方向为从IQS网元到7DCS网元，该接口调用方法为HTTPPost；该接口示例参见附录B.3。接口参数该接口名称为DCS_ID_Del，DCS标识删除请求接口参数见表6，DCS标识删除响应接口参数见表7。表6DCS标识删除请求接口参数是是表7DCS标识删除响应接口参数是6.5.4DCS主数据登记接口接口描述IQS网元可通过主数据登记接口实现在DCS上创建商品的主数据档案，IQS网元向DCS网元登记的商品信息为摘要信息。该接口调用方向为从IQS网元到DCS网元，该接口调用方法为HTTPPost；该接口示例参见附录B.4。接口定义该接口名称为DCS_MasterData_Reg，DCS主数据登记请求接口参数见表8，DCS主数据登记响应接口参数见表9。表8DCS主数据登记请求接口参数是是是是8DB32/TXXXX—2018表9DCS主数据登记响应接口参数是6.5.5DCS事件登记接口接口描述IQS网元可通过DCS事件登记接口实现事件信息上传。该接口调用方向为从IQS网元至DCS网元，该接口的调用方法为HTTPPost。该接口示例参见附录B.5。接口定义该接口名称为DCS_Evn_Reg，DCS事件登记请求接口参数见表10，DCS事件登记响应接口参数见表表10DCS事件登记请求接口参数是是是是表11DCS事件登记响应接口参数是6.5.6DCS追溯信息查询接口接口描述追溯代理应通过DCS追溯信息查询接口获取标识相关的追溯摘要信息。该接口调用方向为从IRS到DCS，该接口调用方法为HTTPPost；该接口示例参见附录B.6。9接口定义该接口名称为DCS_Info_Que，DCS追溯信息查询请求接口参数见表12，DCS追溯信息查询响应接口参数见表13。表12DCS追溯信息查询请求信息是是表13DCS追溯信息查询响应参数是表14evt类型定义食品经营企业IQS服务器的是是DB32/TXXXX—2018（规范性附录）Item类型参数Item类型参数见表A.1。表A.1Item类型参数是是Item类型参数取值见表A.2。表A.2Item类型参数取值ADD：增加;DELETE：移除；OBSERVE（资料性附录）数据接口应用示例B.1DCS标识注册接口应用示例B.1.1HTTP-Request消息的JSON消息体varJSONObject={"MessageName":"DCS_IDList_Reg","CodeList":[{"ID":"urn:cniotroot:id:obj:001.107346.jin"},{"ID":"urn:cniotroot:id:obj:002.107346."}],"IotISURL":"/service.asmx","Structure":"cfst:gtinlot"}B.1.2HTTP-Response消息的JSON消息体varJSONObject={"Status":"Succ"}B.2DCS标识更新接口应用示例B.2.1HTTP-Request消息的JSON消息体varJSONObject={"MessageName":"DCS_ID_Upd","ID":"urn:cniotroot:id:obj:001.107346.iotroot.cn","NewID":"urn:cniotroot:id:obj:001.693107346."，"IotISURL":"/service.asmx"}B.2.2HTTP-Response消息的JSON消息体varJSONObject={B.3DCS标识删除接口应用示例B.3.1HTTP-Request消息的JSON消息体varJSONObject={"MessageName":"DCS_ID_Del","ID":"urn:cniotroot:id:obj:001.107346.iotroot.cn"}B.3.2HTTP-Response消息的JSON消息体varJSONObject={"Status":"Succ"}DB32/TXXXX—2018B.4DCS主数据登记接口应用示例B.4.1HTTP-Request消息的JSON消息体varJSONObject={"MessageName":"DCS_MasterData_Reg","CodeList":[{"ID":"urn:cniotroot:id:obj:001.107346."},{"ID":"urn:cniotroot:id:obj:002.107346."}],"iotISURL":"/service.asmx","MasterData":[{"EveName":"ADD"},{"EveTime":"2017/09/1113:24:35"},{"EvePos":"NanjingXinGangParkNo.12"},{"AlarmContent":"Temperaturetoohigh"}]}B.4.2HTTP-Response消息的JSON消息体varJSONObject={"Status":"Succ"}B.5DCS事件登记接口应用示例B.5.1HTTP-Request消息的JSON消息体varJSONObject={"MessageName":"DCS_Evn_Reg","CodeList":[{"ID":"urn:cniotroot:id:obj:001.107346.jinshi"},{"ID":"urn:cniotro