DB32_T 3411-2018 食品安全电子追溯信息查询服务数据接口规范.pdf
《DB32_T 3411-2018 食品安全电子追溯信息查询服务数据接口规范.pdf》由会员分享,可在线阅读,更多相关《DB32_T 3411-2018 食品安全电子追溯信息查询服务数据接口规范.pdf(45页珍藏版)》请在咨信网上搜索。
1、ICS 67.040 X 00 备案号:60247-2018 DB32 江苏省地方标准 DB 32/T 34112018 食品安全电子追溯信息查询服务 数据接口规范 Interface specifications of information query service for food safety electronic traceability 2018-06-25 发布 2018-07-10 实施 江苏省质量技术监督局 发 布 目 次 前 言.III 1 范围.1 2 规范性引用文件.1 3 术语和定义.1 4 缩略语.2 5 信息查询服务功能要求.2 5.1 系统架构.2 5.2 信
2、息查询服务基本功能.3 6 信息查询服务接口要求.3 6.1 基本要求.3 6.1.1 IQS 传输接口.3 6.1.2 IQS 查询接口.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
3、 接口定义.8 10.3 接口调用.9 附录 A(规范性附录)EPCISEvent 定义.10 附录 B(规范性附录)SimpleEventQuery 时 params 参数.20 附录 C(规范性附录)SimpleMasterDataQuery 时 params 参数.27 附录 D(规范性附录)AuthenticatedEQuery 时 params 参数.29 附录 E(规范性附录)AuthenticatedMDQuery 时 params 参数.36 附录 F(资料性附录)主数据传输应用示例.38 附录 G(资料性附录)事件传输应用示例.39 附录 H(资料性附录)资源文件上传应用示例
4、.40 附录 I(资料性附录)查询接口应用示例.41 前 言 本标准按照GB/T 1.12009给出的规则起草。本标准由江苏省食品药品监督管理局提出并归口。本标准起草单位:江苏省质量和标准化研究院、复旦大学无锡研究院、中科院计算机网络中心、无锡捷玛科技物联有限公司。本标准主要起草人:胡冶、崔兆明、王俊宇、刘毅、曹云、杨博、刘佳、周广军、王瑜、钱侃、王开疆、吴双力、田野。食品安全电子追溯信息查询服务数据接口规范 1 范围 本标准规定了食品安全电子追溯信息查询服务的功能要求、数据接口。本标准适用于食品安全电子追溯信查查询服务的接口实现。2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是
5、注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 17295 国际贸易计量单位代码 DB32/T 3407-2018 食品安全电子追溯标识解析服务数据接口规范 RFC 2616 超文本传输协议1.1(Hypertext transfer protocol-HTTP/1.1)RFC 4627 JSON格式定义(The application/JSON media type for javascript object notation)RFC 4825 可扩展标记语言配置接入协议(The extensible markup
6、language(XML)configuration access protocol(XCAP)3 术语和定义 下列术语和定义适用于本文件。3.1 信息查询服务 information query service 提供追溯信息传输、查询和数据上报功能的服务。3.2 网元 network element 由软硬件共同组成的能实现网络中的一种或多种逻辑功能的逻辑单元。3.3 IQS网元 information query service network element 提供信息查询服务的网元。3.4 IRS网元 identification resolution service network e
7、lement 提供追溯标识注册和追溯标识解析服务的网元。3.5 DCS网元 data catalog service network element 提供追溯路径的建立和查询服务的网元。3.6 EU网元 end user network element 终端用户所使用的具备追溯查询能力的软件系统的统称。3.7 CU网元 capture unit network element 负责采集数据、上传的网元。3.8 SP网元 supervisor platform network element 负责接收IQS网元上报的追溯数据,并利用追溯数据进行监管行为的网元。3.9 追溯代理 traceabil
8、ity proxy 以用户发起的HTTP追溯查询请求为触发,代替追溯用户调用IRS,DCS和IQS网元的多个接口完成追溯查询逻辑功能的网元。4 缩略语 下列缩略语适用于本文件。CU:捕获单元(Capture Unit)DNS:域名服务(Domain Name Service)DCS:数据目录服务(Data Catalog Service)EU:终端用户(End User)IQS:信息查询服务(Information Query Service)IRS:标识解析服务(Identification Resolution Service)JSON:JS对象标记(Java Script Object
9、Notation)RFID:射频识别(Radio Frequency Identification)SP:监管平台(Supervisor Platform)URL:统一资源定位符(Uniform Resource Locator)URN:统一资源名称(Uniform Resource Name)XML:可扩展标记语言(Extensible Markup Language)5 信息查询服务功能要求 5.1 系统架构 食品安全电子追溯系统应由企业平台、监管平台和查询平台组成,食品安全电子追溯系统的系统架构见DB32/T XXXX。信息查询服务由IQS网元实现,IQS网元架构图见图1。图1 IQS
10、网元构架 5.2 信息查询服务基本功能 信息查询服务应提供但不限于以下功能:a)传输服务通过数据传输接口接收企业平台(CU 网元)传输的追溯数据;b)查询服务通过查询接口与查询平台交互实现追溯数据的查询。6 信息查询服务接口要求 6.1 基本要求 食品安全电子追溯系统的各个网元之间应通过Internet公共以太网接口互联互通。IQS网元与其他网元的物理接口上承载的协议栈应为HTTP或HTTPS协议栈,数据接口应使用基于HTTP/HTTPS协议的JSON格式的消息体传输数据。IQS接口分为:a)数据传输接口;b)查询接口。6.1.1 IQS 传输接口 食品生产经营企业信息管理系统通过该接口和IQ
11、S网元交互,使用传输服务。IQS传输接口分为:a)主数据传输接口;b)事件传输接口;c)资源文件传输接口。6.1.2 IQS 查询接口 查询平台通过该接口和IQS网元交互,使用查询服务。6.2 接口原语 基于服务的方式定义数据接口的使用方法。服务响应流程使用了“请求-Request”“指示-Indication”“响应-Response”“确认-Confirm”四条服务原语,原语的顺序见图2。客户端服务器HTTPRequest消息请求-Request指示-IndicationHTTPResponse消息响应-Response确认-Confirm 图2 服务响应流程 6.3 基本数据类型 IQS
12、网元接口基本数据类型见表1。表1 基本数据类型 类型名 类型描述 类型约束 String 文本字符串 内容为所有的有效字符 List 列表类型 每一项均为一个子数据项,子数据项编码方式与父数据项编码方式相同。Time 时间类型 UTC 时间表示法:YYYY-MM-DDTHH:mm:ss.SSSZ 本地时间表示法:YYYY-MM-DDTHH:mm:ss.SSSzoneoffset float 浮点数类型 内容为浮点数类型字符 int 整数类型 内容为整形字符 file 文件流类型 内容为对文件的操作定义 Boolean 数值类型 内容为 True 或 False 6.4 接口调用方式 6.4.1
13、 请求 请求接口应符合RFC 2616中对HTTP请求的规定,使用Get或者POST方法调用接口,并将请求参数按照消息格式用JSON封装后,包含在HTTP的Request消息的Body中发送给对方。6.4.2 响应 接口调用成功后,应由IQS网元进行处理,处理方式应符合RFC 4825对XML的规定或RFC 4627对JSON格式的规定,处理结束后应将处理结果放置在HTTP的Response消息的Body中,返回给调用者。HTTP的Response消息应符合RFC 2616中的规定。7 主数据传输接口 7.1 接口基本功能 提供食品生产经营企业提供向IQS提交静态数据的功能。注:静态数据包括食
14、品生产企业的企业基本信息、原料基本信息、供货厂商基本信息、生产流程基本信息、产成品基本信息、销售商基本信息、原料及产生品检验信息等。7.2 接口定义 接口名称:vocabularyCapture。主数据传输接口请求参数及响应参数见表2、表7。表2 主数据传输接口请求参数 参数名称 类型 最大长度 Byte 是否必填 描述 EPCISMasterDataBody EPCISMasterDataDocumentType 255 是 主数据结构,EPCISMasterDataDocumentType定义见表3 表3 EPCISMasterDataDocumentType 数据结构 参数名称 类型 最
15、大长度 Byte 是否必填 描述 VocabularyList List 单个标识最大长度为 255 是 主数据列表,VocabularyListType 定义见表 4 表4 VocabularyListType 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 type String 255 是 主数据类型 参数名称 类型 最大长度 Byte 是否必填 描述 VocabularyElementList List 单个标识最大长度为 255 是 主数据内容列表,VocabularyElementListType 定义见表 5 表5 VocabularyElementListType
16、 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 id String 255 是 主数据主键 attribute List 单个标识最大长度为 255 是 主数据属性,attributeType 定义见表 6 表6 attributeType 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 id String 255 是 属性名称/编码 value String 255 是 属性内容 表7 主数据传输接口返回参数 参数名称 类型 最大长度 Byte 是否必填 描述 Status String 255 是 返回数据传输结果 success:传输成功,false:传输失
17、败 7.3 接口调用 静态数据不随生产活动而变化,静态数据因企业其他活动发生改变时调用该接口。接口调用方向:由CU网元向IQS网元提出请求。注:调用示例可参见附录F。8 事件传输接口 8.1 接口基本功能 提供食品生产经营企业提供向IQS提交动态数据的功能。注:动态数据包括与企业生产化活动相关的数据,如原辅料及产成品进销存数量、生产投料等数据 8.2 接口定义 接口名称:Capture。事件传输请求参数及响应参数见表8、表9。表8 事件传输接口请求参数 参数名称 类型 最大长度 Byte 是否必填 描述 event List 单个标识最大长度为 255 是 事件数据结构,EPCISEvent
18、定义见附录 A 表9 事件传输接口响应参数 参数名称 类型 最大长度 Byte 是否必填 描述 Status String 255 是 返回数据传输结果 success:提交成功,falser:提交失败 8.3 接口调用 接口调用方向:由CU网元向IQS网元提出请求。注:调用示例可参见附录G。9 资源文件传输接口 9.1 接口基本功能 提供食品生产经营企业向IQS上传资源文件的的功能,资源文件应包含图片、视频、文档文件等。9.2 接口定义 接口名称:resUpload。资源文件传输接口请求参数及响应参数见表10、表11。表10 资源文件传输接口请求参数 参数名称 类型 最大长度 Byte 是否
19、必填 描述 filePath file 255 是 待上传文件 表11 资源文件传输接口响应参数 参数名称 类型 最大长度 Byte 是否必填 描述 status String 255 是 返回值,用于表示状态:success 上传成功,false 上传失败 fileURL String 255 否 返回值为 success 时,本字段存放可用于访问的文件 URL;否则为空 9.3 接口调用 接口调用方向:由CU网元向IQS网元提出请求。注:调用示例可参见附录H。10 查询接口 10.1 接口基本功能 提供从IQS查询符合条件的静态数据和动态数据的功能。10.2 接口定义 接口名称:poll。
20、查询接口请求参数:见表12、表13。表12 查询接口请求参数 参数名称 类型 最大长度 Byte 是否必填 描述 queryName String 255 是 查询名称,可使用项目见表 13 params QueryParams 255 是 查询参数,根据不同的查询名称,参数也不同,见表 14 表13 queryName 参数 queryName 值 说明和 params 定义 SimpleEventQuery 匿名事件查询,params 定义见附录 B SimpleMasterDataQuery 匿名主数据查询,params 定义见附录 C AuthenticatedEQuery 认证用户事
21、件查询,params 定义见附录 D AuthenticatedMDQuery 认证用于主数据查询,params 定义见附录 E 表14 查询接口返回参数 参数名称 类型 长度 byte 是否必填 描述 queryName String 1-255 本参数与请求参数中的 queryName 一致 resultsBody QueryResultsBody 1-255 返回的查询结果,本参数的类型由请求参数的 queryName 决定:当 queryName 为 SimpleEventQuery 和AuthenticatedEQuery 时,本参数的数据类型定义见附录 A;当 queryName
22、为 SimpleMasterDataQuery和 AuthenticatedMDQuery 时,本参数的数见表 4 10.3 接口调用 接口调用方向:由CU网元、EU网元、SP网元通过追溯代理向IQS网元提出请求。注:调用示例可参见附录I。附 录 A(规范性附录)EPCISEvent 定义 A.1 ObjectEvent子类数据结构 EPCISEvent是一个对于所有IQS事件的基础类型,ObjectEvent是其一个子类,用于记录对象事件数据,结构见表A.1。表A.1 ObjectEvent 子类数据结构 字段名称 字段类型 最大长度 Byte 是否必填 描述 eventTime Time
23、255 是 事件发生时间 recordTime Time 255 否 这个事件被 IQS 记录的日期时间,在事件提交到 IQS 传输接口时必须忽略,由 IQS自动记录;在查询时可以获得 eventTimeZoneOffset String 255 是 时间发生地点时区与 UTC 时区的差值,这个字段的值应是字符串,以+或者-开头,后两位是在 00 到 14 之间(包括 00,14)的数字,接着是一个冒号,后面是两位在 00 到 59 之间(包括 00 和 59)的数字,若前两位是 14,后两位必须是 00 epcList List 单个标识最大长度为 255 否 单件追溯标识数组,EPC 定义
24、见 A.5.1,epcList 与 quantityList 两者至少存在 1项 quantityList List 单个标识最大长度为 255 否 批次追溯标识数组,QuantityElement 定义见 A.5.2,epcList 与 quantityList 两者至少存在 1 项 action Action 255 是 事件导致的物品状态变化,ADD:增加;DELETE:移除;OBSERVE:不变 bizStep BusinessStepID 255 否 业务步骤,值见 A.5.7 disposition DispositionID 255 否 物品状态,值见 A.5.8 readPoi
25、nt ReadPointID 255 否 事件发生时刻的业务位置标识 bizLocation BusinessLocationID 255 否 事件发生后,物品所在业务位置标识 bizTransactionList List 单个标识最大长度为 255 否 与 事 件 相 关 的 事 务 单 据 数 组,BusinessTransaction 定义见 A.5.3 sourceList List 单个标识最大长度为 255 否 在整个事务中开始的位置,Source 定义见A.5.4 表 A.1(续)字段名称 字段类型 最大长度 Byte 是否必填 描述 destinationList List
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- DB32_T 3411-2018 食品安全电子追溯信息查询服务数据接口规范 3411 2018 食品安全 电子 追溯 信息 查询 服务 数据 接口 规范
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【Fis****915】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【Fis****915】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。