食品安全电子追溯信息查询服务数据接口规范

1食品安全电子追溯信息查询服务数据接口规范本标准规定了食品安全电子追溯信息查询服务的功能要求、数据接口。本标准适用于食品安全电子追溯信查查询服务的接口实现。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T17295国际贸易计量单位代码DB32/TXXXX-2018食品安全电子追溯标识解析服务数据接口规范RFC2616超文本传输协议1.1(Hypertexttransferprotocol--HTTP/1.1)RFC4627JSON格式定义(Theapplication/JSONmediatypeforjavascriptobjectnotation)RFC4825可扩展标记语言配置接入协议(Theextensiblemarkuplanguage(XML)configurationaccessprotocol(XCAP))3术语和定义下列术语和定义适用于本文件。3.1信息查询服务informationqueryservice提供追溯信息传输、查询和数据上报功能的服务。3.2网元networkelement由软硬件共同组成的能实现网络中的一种或多种逻辑功能的逻辑单元。3.3IQS网元informationqueryservicenetworkelement提供信息查询服务的网元。3.4IRS网元identificationresolutionservicenetworkelement提供追溯标识注册和追溯标识解析服务的网元。23.5DCS网元datacatalogservicenetworkelement提供追溯路径的建立和查询服务的网元。3.6EU网元endusernetworkelement终端用户所使用的具备追溯查询能力的软件系统的统称。3.7CU网元captureunitnetworkelement负责采集数据、上传的网元。3.8SP网元supervisorplatformnetworkelement负责接收IQS网元上报的追溯数据，并利用追溯数据进行监管行为的网元。3.9追溯代理traceabilityproxy以用户发起的HTTP追溯查询请求为触发，代替追溯用户调用IRS,DCS和IQS网元的多个接口完成追溯查询逻辑功能的网元。4缩略语下列缩略语适用于本文件。CU：捕获单元(CaptureUnit)DNS：域名服务(DomainNameService)DCS：数据目录服务(DataCatalogService)EU：终端用户(EndUser)IQS：信息查询服务(InformationQueryService)IRS：标识解析服务(IdentificationResolutionService)JSON：JS对象标记(JavaScriptObjectNotation)RFID：射频识别(RadioFrequencyIdentification)SP：监管平台(SupervisorPlatform)URL：统一资源定位符(UniformResourceLocator)URN：统一资源名称（UniformResourceName）XML：可扩展标记语言(ExtensibleMarkupLanguage)5信息查询服务功能要求5.1系统架构3食品安全电子追溯系统应由企业平台、监管平台和查询平台组成，食品安全电子追溯系统的系统架构见DB32/TXXXX。信息查询服务由IQS网元实现，IQS网元架构图见图1。图1IQS网元构架5.2信息查询服务基本功能信息查询服务应提供但不限于以下功能：a)传输服务——通过数据传输接口接收企业平台（CU网元）传输的追溯数据；b)查询服务——通过查询接口与查询平台交互实现追溯数据的查询。6信息查询服务接口要求6.1基本要求食品安全电子追溯系统的各个网元之间应通过Internet公共以太网接口互联互通。IQS网元与其他网元的物理接口上承载的协议栈应为HTTP或HTTPS协议栈，数据接口应使用基于HTTP/HTTPS协议的JSON格式的消息体传输数据。IQS接口分为：a)数据传输接口；b)查询接口。6.1.1IQS传输接口食品生产经营企业信息管理系统通过该接口和IQS网元交互，使用传输服务。IQS传输接口分为：a)主数据传输接口；b)事件传输接口；c)资源文件传输接口。46.1.2IQS查询接口查询平台通过该接口和IQS网元交互，使用查询服务。6.2接口原语基于服务的方式定义数据接口的使用方法。服务响应流程使用了“请求-Request”“指示-Indication”“响应-Response”“确认-Confirm”四条服务原语，原语的顺序见图2。图2服务响应流程6.3基本数据类型IQS网元接口基本数据类型见表1。表1基本数据类型每一项均为一个子数据项，子数据项编码方式与父数本地时间表示法：YYYY-MM-DDTHH:mm:ss.SSS±zon6.4接口调用方式6.4.1请求5请求接口应符合RFC2616中对HTTP请求的规定，使用Get或者POST方法调用接口，并将请求参数按照消息格式用JSON封装后，包含在HTTP的Request消息的Body中发送给对方。6.4.2响应接口调用成功后，应由IQS网元进行处理，处理方式应符合RFC4825对XML的规定或RFC4627对JSON格式的规定，处理结束后应将处理结果放置在HTTP的Response消息的Body中，返回给调用者。HTTP的Response消息应符合RFC2616中的规定。7主数据传输接口7.1接口基本功能提供食品生产经营企业提供向IQS提交静态数据的功能。注：静态数据包括食品生产企业的企业基本信息、原料基本信息、供7.2接口定义接口名称：vocabularyCapture。主数据传输接口请求参数及响应参数见表2、表7。表2主数据传输接口请求参数EPCISMasterDataDocumen是EPCISMasterDataDocumentType定义见表3表3EPCISMasterDataDocumentType数据结构是表4VocabularyListType数据参数是表4（续）是6表5VocabularyElementListType数据参数是是表6attributeType数据参数是是表7主数据传输接口返回参数是7.3接口调用静态数据不随生产活动而变化，静态数据因企业其他活动发生改变时调用该接口。接口调用方向：由CU网元向IQS网元提出请求。8事件传输接口8.1接口基本功能提供食品生产经营企业提供向IQS提交动态数据的功能。注：动态数据包括与企业生产化活动相关的数据，如原辅料及产成品进销8.2接口定义接口名称：Capture。事件传输请求参数及响应参数见表8、表9。表8事件传输接口请求参数7是表9事件传输接口响应参数是8.3接口调用接口调用方向：由CU网元向IQS网元提出请求。9资源文件传输接口9.1接口基本功能提供食品生产经营企业向IQS上传资源文件的的功能，资源文件应包含图片、视频、文档文件等。9.2接口定义接口名称：resUpload。资源文件传输接口请求参数及响应参数见表10、表11。表10资源文件传输接口请求参数是表11资源文件传输接口响应参数是否返回值为success时，本字段存放可用于9.3接口调用接口调用方向：由CU网元向IQS网元提出请求。810查询接口10.1接口基本功能提供从IQS查询符合条件的静态数据和动态数据的功能。10.2接口定义接口名称：poll。查询接口请求参数：见表12、表13。表12查询接口请求参数是是查询参数，根据不同的查询名称，参数也表13queryName参数表14查询接口返回参数返回的查询结果，本参数的类型由请求参10.3接口调用接口调用方向：由CU网元、EU网元、SP网元通过追溯代理向IQS网元提出请求。9（规范性附录）EPCISEvent定义A.1ObjectEvent子类数据结构EPCISEvent是一个对于所有IQS事件的基础类型，ObjectEvent是其一个子类，用于记录对象事件数据，结构见表A.1。表A.1ObjectEvent子类数据结构是否这个事件被IQS记录的日期时间，在事件提交到IQS传输接口时必须忽略，由IQS是否单件追溯标识数组，EPC定义见A.5.1，项否见A.5.2，epcList与quanti是变否否否否>否否表A.1（续）否否否A.2AggregationEvent子类数据结构定义EPCISEvent是一个对于所有IQS事件的基础类型，AggregationEvent是其一个子类，用于记录聚合事件和包含物流包装的事件，具体内容见表A.2。表A.2AggregationEvent子类数据结构定义是是否否单件追溯标识数组，EPC定义见A.5.1，存在一项否是ADD：向容器增加;DELETE：从容器否否否表A.2（续）否List<BusinessTransa否否在整个事务中开始的位置，Source定义见t否否A.3TransactionEvent子类数据结构定义EPCISEvent是一个对于所有IQS事件的基础类型，TransactionEvent是其一个子类，用于记录带有事务过程的业务事件信息，具体内容见表A.3。表A.3TransactionEvent子类数据结构定义是是List<BusinessTransa是否否否表A.3（续）是ADD：事务发生时/新增对象时；DELETE事中否否否否否在整个事务中开始的位置，Source定义见t否否存放事件的详细信息，EvtElementList定A.4TransformationEvent子类数据结构定义EPCISEvent是一个对于所有IQS事件的基础类型，TransformationEvent是其一个子类，用于记录投料产出事件信息，具体内容见表A.4。表A.4TransformationEvent子类数据结构定义是否是否表A.4（续）否存在1项,当transformationID赋值时，outputEPCList、output否单件追溯标识数组，EPC定义见A.5.1。当outputEPCList、output否outputEPCList、output否否否否否List<BusinessTransa否否在整个事务中开始的位置，Source定义见t否否否A.5相关数据结构定义A.5.1EPC数据结构定义EPC用于记录一个用于单件追溯的追溯标识，类型为String，使用资源标识符形式。A.5.2QuantityElement数据结构定义QuantityElement用于记录批次追溯的追溯标识，定义见表A.5。表A.5QuantityElement数据结构定义是是数量，数量用于形容epcClass如何标称。于表示epcClass的内容的个数；如果存在是epcClass所对应的对象的数量，使用GB/TA.5.3BusinessTransaction数据结构定义BusinessTransaction用于记录事件中事务相关的单据信息，定义见表A.6、A.7所示。表A.6BusinessTransaction数据结构定义是是表A.7BizTransTypeID数据结构定义A.5.4Source/Destination数据结构定义Source/Destination用于记录开始/结束的业务位置、所有者、管理方信息，定义见表A.8、A.9所示。表A.8Source/Destination数据结构定义是是表A.9SourceDestTypeID数据结构定义A.5.5EvtElementList数据结构定义EvtElementList用于记录事件中的详细信息，定义见表A.10、A.11所示。表A.10EvtElementList数据结构定义是是是是是表A.11extID数据结构定义A.5.6ILMD数据结构定义ILMD用于保存事件中额外的主数据信息，可由多组属性组成，每组属性定义见表A.12所示。表A.12ILMD属性数据结构定义是是A.5.7BusinessStepID值定义BusinessStepID用于表示一项具体的业务过程。BusinessStepID应使用URN形式表示，表A.13中的BusinessStepID在使用时的格式为：urn:epcglobal:cbv:bizstep:BusinessStepID。表A.13BusinessStepID值定义逆该阶段与staging_outboun表A.13（续）A.5.8DispositionID值定义DispositionID用于表示追溯物品在事件发生后的状态。DispositionID应使用URN形式表示，表A.14中的DispositionID在使用时的格式为：urn:epcglobal:cbv:disp:DispositionID。表A.14ISO/IEC19988定义的DispositionID值定义表A.14（续）removing、repairing、replreturned_nonsellable_other_retail_soldunknown（资料性附录）SimpleEventQuery时params参数SimpleEventQuery时params参数见表B.1。表B.1SimpleEventQuery时params参数否），件，本参数的取值可以为：ObjectEvenAggregationEvent,TransactionEven否否否否否否n否表B.1（续）否如果本参数和WD_readPoint参数同时被省否如果本参数和EQ_readPoint参数同时被省否务交易列表中某个条目的type子字段与从否_type否表中某个条目的type子字段与从本参数提否表B.1（续）否D否C否否否epcList，childEPCs，i表B.1（续）s否childQuantityList、qchildQuantityList字段中的某个EPC与本否否否quantityList，childQua件表B.1（续）否否否否表B.1（续）否否否表B.1（续）n否否否（规范性附录）SimpleMasterDataQuery时params参数SimpleMasterDataQuery时params参数见表C.1。表C.1SimpleMasterDataQuery时params参数否是n是含否否否否表C.1（续）e否同t否（规范性附录）AuthenticatedEQuery时params参数AuthenticatedEQuery时params参数见表D.1。表D.1AuthenticatedEQuery时params参数说明是是大长度为255否），否否否否大长度为255否action字段并且该字段的取值与指定的参大长度为255否表D.1（续）否否否否否否bizTransactionList、业务否表D.1（续）否否否epcList字段中的EPC或者childEPCs与本D否AggregationEvent、TranC否表D.1（续）否在否epcList，childEPCs，is否childQuantityList、q否否表D.1（续）否quantityList，childQua件否否表D.1（续）否否否表D.1（续）n否），否否（规范性附录）AuthenticatedMDQuery时params参数AuthenticatedMDQuery时params参数见表E.1。表E.1AuthenticatedMDQuery时params参数说明是是e否是是含s否否否否表E.1（续）否同否（资料性附录）主数据传输应用示例示例为调用主数据传输接口向IQS传输企业基本信息，上传结果成功。请求：<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?><epcismd:EPCISMasterDataDocumentxmlns:epcismd="urn:epcglobal:epcis-masterdata:xsd:1"xmlns:xsi="/2001/XMLSchema-instance"schemaVersion="1.0"creationDate="2005-07-11T11:30:47.0Z"><EPCISBody><VocabularyList><Vocabularytype="urn:cniotroot:vtype:companyInfo"><VocabularyElementList><VocabularyElementid="urn:cniotroot:id:hostURL:"><attributeid="companyName">XX酒业股份有限公司</attribute><attributeid="businessLicense">320826000001107</attribute></VocabularyElement></VocabularyElementList></Vocabulary></VocabularyList></EPCISBody></epcismd:EPCISMasterDataDocument>响应参数success｝（资料性附录）事件传输应用示例示例为调用事件传输接口向IQS传输生产过程信息，上传结果成功。请求：<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?><epcis:EPCISDocumentxmlns:epcis="urn:epcglobal:epcis:xsd:1"xmlns:example="/epcis"xmlns:xsi="/2001/XMLSchema-instance"creationDate="2005-07-11T11:30:47.0Z"schemaVersion="1.1"><EPCISBody><EventList><ObjectEvent><eventTime>2005-04-03T20:33:31.116-06:00</eventTime><eventTimeZoneOffset>-06:00</eventTimeZoneOffset><epcList><epc>urn:cniotroot:id:obj:001.107346.</epc><epc>urn:cniotroot:id:obj:002.107346.</epc></epcList><action>OBSERVE</action><bizStep>urn:epcglobal:cbv:bizstep:shipping</bizStep><disposition>urn:epcglobal:cbv:disp:in_transit</disposition><readPoint><id>urn:cniotroot:id:loc:001.</id></readPoint><bizTransactionList><bizTransactiontype="urn:epcglobal:cbv:btt:po">/po/12345678</bizTransaction></bizTransactionList></ObjectEvent></EventList></EPCISBody></epcis:EPCISDocument>响应success｝（资料性附录）资源文件上传应用示例示例为调用资源文件传输接口向IQS传输图片文件，上传结果成功。请求：C:\PICTU