DB32/T 3411-2018 食品安全电子追溯信息查询服务数据接口规范

ICS67.040

X00

备案号：DB32

江苏省地方标准

DB32/T3411—2018

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

规范

Interfacespecificationsofinformationqueryserviceforfoodsafetyelectronic

traceability

2018-6-25发布2018-7-10实施

江苏省质量技术监督局发布

DB32/T3411—2018

目  次

前  言.............................................................................................................................................................III

1范围...................................................................................................................................................................1

2规范性引用文件...............................................................................................................................................1

3术语和定义.......................................................................................................................................................1

4缩略语...............................................................................................................................................................2

5信息查询服务功能要求...................................................................................................................................2

5.1系统架构...................................................................................................................................................2

5.2信息查询服务基本功能...........................................................................................................................3

6信息查询服务接口要求...................................................................................................................................3

6.1基本要求...................................................................................................................................................3

6.1.1IQS传输接口....................................................................................................................................3

6.1.2IQS查询接口....................................................................................................................................4

6.2接口原语...................................................................................................................................................4

6.3基本数据类型...........................................................................................................................................4

6.4接口调用方式...........................................................................................................................................4

6.4.1请求...................................................................................................................................................4

6.4.2响应...................................................................................................................................................5

7主数据传输接口...............................................................................................................................................5

7.1接口基本功能...........................................................................................................................................5

7.2接口定义...................................................................................................................................................5

7.3接口调用...................................................................................................................................................6

8事件传输接口...................................................................................................................................................6

8.1接口基本功能...........................................................................................................................................6

8.2接口定义...................................................................................................................................................6

8.3接口调用...................................................................................................................................................7

9资源文件传输接口...........................................................................................................................................7

9.1接口基本功能...........................................................................................................................................7

9.2接口定义...................................................................................................................................................7

9.3接口调用...................................................................................................................................................7

10查询接口.........................................................................................................................................................8

10.1接口基本功能.........................................................................................................................................8

10.2接口定义.................................................................................................................................................8

10.3接口调用.................................................................................................................................................8

I

DB32/T3411—2018

附录A（规范性附录）EPCISEvent定义.....................................................................................................9

附录B（规范性附录）SimpleEventQuery时params参数....................................................................19

附录C（规范性附录）SimpleMasterDataQuery时params参数..........................................................26

附录D（规范性附录）AuthenticatedEQuery时params参数..............................................................29

附录E（规范性附录）AuthenticatedMDQuery时params参数............................................................35

附录F（资料性附录）主数据传输应用示例............................................................................................37

附录G（资料性附录）事件传输应用示例................................................................................................39

附录H（资料性附录）资源文件上传应用示例........................................................................................40

附录I（资料性附录）查询接口应用示例................................................................................................40

II

DB32/T3411—2018

前  言

本标准按照GB/T1.1—2009给出的规则起草。

本标准由江苏省食品药品监督管理局提出并归口。

本标准起草单位：江苏省质量和标准化研究院、复旦大学无锡研究院、中科院计算机网络中心、无

锡捷玛科技物联有限公司。

本标准主要起草人：胡冶、崔兆明、王俊宇、刘毅、曹云、杨博、刘佳、周广军、王瑜、钱侃、王

开疆、吴双力、田野。

III

DB32/T3411—2018

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

1范围

本标准规定了食品安全电子追溯信息查询服务的功能要求、数据接口。

本标准适用于食品安全电子追溯信查查询服务的接口实现。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。

凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB/T17295国际贸易计量单位代码

DB32/TXXXX-2018食品安全电子追溯标识解析服务数据接口规范

RFC2616超文本传输协议1.1(Hypertexttransferprotocol--HTTP/1.1)

RFC4627JSON格式定义(Theapplication/JSONmediatypeforjavascriptobject

notation)

RFC4825可扩展标记语言配置接入协议(Theextensiblemarkuplanguage(XML)

configurationaccessprotocol(XCAP))

3术语和定义

下列术语和定义适用于本文件。

3.1

信息查询服务informationqueryservice

提供追溯信息传输、查询和数据上报功能的服务。

3.2

网元networkelement

由软硬件共同组成的能实现网络中的一种或多种逻辑功能的逻辑单元。

3.3

IQS网元informationqueryservicenetworkelement

提供信息查询服务的网元。

3.4

IRS网元identificationresolutionservicenetworkelement

提供追溯标识注册和追溯标识解析服务的网元。

1

DB32/T3411—2018

3.5

DCS网元datacatalogservicenetworkelement

提供追溯路径的建立和查询服务的网元。

3.6

EU网元endusernetworkelement

终端用户所使用的具备追溯查询能力的软件系统的统称。

3.7

CU网元captureunitnetworkelement

负责采集数据、上传的网元。

3.8

SP网元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系统架构

2

DB32/T3411—2018

食品安全电子追溯系统应由企业平台、监管平台和查询平台组成，食品安全电子追溯系统的系统架

构见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)资源文件传输接口。

3

DB32/T3411—2018

6.1.2IQS查询接口

查询平台通过该接口和IQS网元交互，使用查询服务。

6.2接口原语

基于服务的方式定义数据接口的使用方法。服务响应流程使用了“请求-Request”“指示

-Indication”“响应-Response”“确认-Confirm”四条服务原语，原语的顺序见图2。

图2服务响应流程

6.3基本数据类型

IQS网元接口基本数据类型见表1。

表1基本数据类型

类型名类型描述类型约束

String文本字符串内容为所有的有效字符

List<>列表类型每一项均为一个子数据项，子数据项编码方式与父数据项编码方式相同。

Time时间类型UTC时间表示法：YYYY-MM-DDTHH:mm:ss.SSSZ

本地时间表示法：YYYY-MM-DDTHH:mm:ss.SSS±zoneoffset

float浮点数类型内容为浮点数类型字符

int整数类型内容为整形字符

file文件流类型内容为对文件的操作定义

Boolean数值类型内容为True或False

6.4接口调用方式

6.4.1请求

4

DB32/T3411—2018

请求接口应符合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主数据传输接口请求参数

参数名称类型最大长度是否描述

Byte必填

EPCISMasterDEPCISMasterDataDocumentType255是主数据结构，

ataBodyEPCISMasterDataDocumentType定义见表3

表3EPCISMasterDataDocumentType数据结构

参数名称类型最大长度是否描述

Byte必填

VocabularyLiList<VocabularyListType>单个标识最大是主数据列表，VocabularyListType定义见

st长度为255表4

表4VocabularyListType数据参数

参数名称类型最大长度是否描述

Byte必填

typeString255是主数据类型

表4（续）

参数名称类型最大长度是否描述

Byte必填

VocabularyElList单个标识最大是主数据内容列表，

ementList<VocabularyElementListType>长度为255VocabularyElementListType定义见表5

5

DB32/T3411—2018

表5VocabularyElementListType数据参数

参数名称类型最大长度是否描述

Byte必填

idString255是主数据主键

attributeList<attributeType>单个标识最大是主数据属性，attributeType定义见表6

长度为255

表6attributeType数据参数

参数名称类型最大长度是否描述

Byte必填

idString255是属性名称/编码

valueString255是属性内容

表7主数据传输接口返回参数

参数名称类型最大长度是否描述

Byte必填

StatusString255是返回数据传输结果

success：传输成功，false：传输失败

7.3接口调用

静态数据不随生产活动而变化，静态数据因企业其他活动发生改变时调用该接口。

接口调用方向：由CU网元向IQS网元提出请求。

注：调用示例可参见附录F。

8事件传输接口

8.1接口基本功能

提供食品生产经营企业提供向IQS提交动态数据的功能。

注：动态数据包括与企业生产化活动相关的数据，如原辅料及产成品进销存数量、生产投料等数据

8.2接口定义

接口名称：Capture。

事件传输请求参数及响应参数见表8、表9。

表8事件传输接口请求参数

参数名称类型最大长度是否描述

Byte必填

6

DB32/T3411—2018

eventList<EPCISEvent>单个标识最大是事件数据结构，EPCISEvent定义见附录A

长度为255

表9事件传输接口响应参数

参数名称类型最大长度是否描述

Byte必填

StatusString255是返回数据传输结果

success：提交成功，falser：提交失败

8.3接口调用

接口调用方向：由CU网元向IQS网元提出请求。

注：调用示例可参见附录G。

9资源文件传输接口

9.1接口基本功能

提供食品生产经营企业向IQS上传资源文件的的功能，资源文件应包含图片、视频、文档文件等。

9.2接口定义

接口名称：resUpload。

资源文件传输接口请求参数及响应参数见表10、表11。

表10资源文件传输接口请求参数

参数名称类型最大长度是否描述

Byte必填

filePathfile255是待上传文件

表11资源文件传输接口响应参数

参数名称类型最大长度是否描述

Byte必填

statusString255是返回值，用于表示状态：

success上传成功，false上传失败

fileURLString255否返回值为success时，本字段存放可用于

访问的文件URL；否则为空

9.3接口调用

接口调用方向：由CU网元向IQS网元提出请求。

注：调用示例可参见附录H。

7

DB32/T3411—2018

10查询接口

10.1接口基本功能

提供从IQS查询符合条件的静态数据和动态数据的功能。

10.2接口定义

接口名称：poll。

查询接口请求参数：见表12、表13。

表12查询接口请求参数

参数名称类型最大长度是否描述

Byte必填

queryNameString255是查询名称，可使用项目见表13

paramsQueryParams255是查询参数，根据不同的查询名称，参数也

不同，见表14

表13queryName参数

queryName值说明和params定义

SimpleEventQuery匿名事件查询，params定义见附录B

SimpleMasterDataQuery匿名主数据查询，params定义见附录C

AuthenticatedEQuery认证用户事件查询，params定义见附录D

AuthenticatedMDQuery认证用于主数据查询，params定义见附录E

表14查询接口返回参数

参数名称类型长度byte是否描述

必填

queryNameString1-255本参数与请求参数中的queryName一致

resultsBodyQueryResultsBody1-255返回的查询结果，本参数的类型由请求参

数的queryName决定：

当queryName为SimpleEventQuery和

AuthenticatedEQuery时，本参数的数据类

型定义见附录A；

当queryName为SimpleMasterDataQuery

和AuthenticatedMDQuery时，本参数的数