2022气瓶质量安全追溯系统第2部分:数据接口
气瓶质量安全追溯系统第 2 部分:数据接口目次1 范围12 规范性引用文件13 术语和定义14 缩略语15 总体要求26 接口消息格式27 接口基本功能和参数3参考文献11I气瓶质量安全追溯系统 第 2 部分:数据接口1 范围本文件规定了气瓶质量安全追溯系统数据接口的总体要求、接口消息格式、接口基本功能和参数。本文件适用于液化石油气气瓶和液化二甲醚气瓶的气瓶质量安全追溯系统的数据接口。2 规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件, 仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 13000信息技术 通用多八位编码字符集(UCS)RFC 2616超文本传输协议1.1(Hypertext Transfer ProtocolHTTP/1.1)RFC 4627 JSON 应用与媒体类型The application/json Media Type for JavaScript Object Notation(JSON)3 术语和定义下列术语和定义适用于本文件。3.1气瓶信息化标签实现气瓶生命周期中充装验证和追溯的信息化媒介。3.2编码字符集一组明确的规则,它建立字符集和该字符集内的字符与其位组之间一一对应的关系。来源:GB/T 1988-1998,4.64 缩略语下列缩略语适用于本文件。GTM:格林威治时间(Greenwich Mean Time) HTML:超文本置标语言(Hyper Text Markup Language)HTTP:超文本传输协议(Hyper Text Transfer Protocol)HTTPS:超文本传输安全协议(Hyper Text Transfer Protocol over Secure Socket Layer 或Hypertext Transfer Protocol Secure)ID:标识符(Identifier)JSON:轻量级的数据交换格式(JavaScript Object Notation) MIME:多用途互联网邮件扩展(Multipurpose Internet Mail Extensions)15 总体要求5.1 通信协议应采用符合RFC 2616的HTTP或HTTPS。5.2 接口描述宜使用标准化的或比较通用的文本描述语言,如JSON(RFC4627)。5.3 编码字符集应符合GB/T 13000的要求。5.4 数据类型气瓶质量安全追溯系统数据接口应覆盖所能支持数据类型,包括:字符串型(String);数字型(Number);时间型(DateTime);对象型(Object);数组型(Array);布尔型(Boolean);空(NULL)。注:对“时间”类信息,以“1970年1月1日,00:00:00(GTM时间)”作为基准起始时间。6 接口消息格式6.1 请求消息格式6.1.1 消息格式请求消息由请求头和请求参数组成。应使用HTTP规定的POST请求方法。6.1.2 请求头不同接口具有统一请求头,请求头的名称及其含义描述应符合表1的规定。表1 请求头名称描述必选/可选Host指定请求的服务器的域名和端口号必选Connection表示是否需要持久连接必选Accept表示接受所接收的内容类型必选Content-Type请求的与实体对应的MIME信息必选Content-Lentgh请求的内容长度必选2表 1 (续)名称描述必选/可选CookieHTTP请求发送时,会把保存在该请求域名下的所有cookie值一起发送给网站服务器可选User-Agent内容包含发出请求的用户信息可选Token访问连接的密钥信息可选6.1.3 请求参数请求参数格式见示例列表形式,根据不同接口功能,其请求参数不同。示例:参数名数据类型必选/可选描述给出该字段所代表的参数名用于描述数据的数据类型描述该参数是否为必选对参数的描述及补充说明-6.2 响应消息格式6.2.1 消息格式响应消息由响应头和响应消息参数组成。应使用HTTP规定的POST请求方法。6.2.2 响应头不同接口具有同一响应头,响应头的名称及其含义描述应符合表2的规定。表2 响应头名称描述必选/可选Content-Type请求的与实体对应的MIME信息必选Content-Length请求的内容长度必选Date服务器消息发出的时间可选Server服务器软件名称可选6.2.3 响应参数响应消息参数格式见示例列表形式,根据不同接口功能,其响应消息参数不同。示例:参数名数据类型必选/可选描述给出该字段所代表的参数名用于描述数据的数据类型描述该参数是否为必选对参数的描述及补充说明-7 接口基本功能和参数7.1 接口流程企业平台向监管平台上报数据或请求数据的接口流程应符合图1,接口的流程如下:a) 企业平台发出请求,上报数据或请求数据;b) 监管平台对该次请求进行处理;3c) 处理后由监管平台向企业平台返回处理结果。图1 接口流程7.2 初始化连通接口7.2.1 功能用于企业平台和监管平台间建立初始化连通。7.2.2 请求参数初始化连通请求参数应符合表3的规定。表3 初始化连通请求参数参数名数据类型必选/可选描述app_idString必选接入方IDapp_keyString必选接入方功能板块信息app_secretString必选接入方密钥7.2.3 响应消息参数初始化连通响应消息参数应符合表4的规定。表4 初始化连通响应消息参数参数名数据类型必选/可选描述statusNumber必选本次请求处理状态码msgString必选本次请求处理结果描述access_tokenString必选接入获取到的密钥expriesNumber必选密钥过期时间47.3 请求类接口7.3.1 请求类接口列表请求类接口列表应符合表5的规定。表5 请求类接口列表中文名称英文名称必选/可选气瓶基本信息product必选气瓶充装信息fill必选气瓶检验信息check可选气瓶信息化标签信息tag可选7.3.2 请求类接口基本功能和参数7.3.2.1 气瓶基本信息7.3.2.1.1 功能用于企业平台查询监管平台内气瓶基本信息。7.3.2.1.2 请求参数气瓶基本信息请求参数应符合表6的规定。表6 气瓶基本信息请求参数参数名数据类型必选/可选描述inner_codeString必选查询气瓶的单位内编码7.3.2.1.3 响应消息参数气瓶基本信息响应信息参数应符合表7的规定。表7 气瓶基本信息响应消息参数名称数据类型必选/可选描述pro_varietyString必选设备品种pro_nameString必选产品名称pro_noString必选气瓶生产编号fill_mediaNumber必选充装介质:0 液化石油气,1 二甲醚,2 氧气,3 二氧化碳,4 溶解乙炔make_unitString必选制造单位make_timeDateTime必选生产日期work_pressureNumber必选公称工作压 (MPa)volumeNumber必选容积(L)check_timeDateTime必选最近 次检验 日期(新瓶该值填写出厂日期)5表7 (续)名称数据类型必选/可选描述next_check_timeDateTime必选下次检验日期(液化石油气瓶顺延 4 年气瓶下一次需要送检验站检验的日期)regist_codeString可选气瓶使 登记代码change_eventString可选变更情况(主要记录产权过户日志)memoString可选备注inner_codeString必选单位内编号stamp_make_unitString可选气瓶钢印制造单位名称pro_uuidString必选产品唯一性编码chip_idString可选芯片 id(每一个批次生成的登记证编号)locationString可选归属地(客户、门店、气站、检测机构):0001 门店, 0002 气站,0003 企业,0004 检验机构,005 移动库,006 客户statusString必选气瓶状态在用(已检测)、停用(待检测)、报废: submit 新瓶提交,using 在用(已检测),stop 停用(待检测),scrapped 报废check_organizationString可选检测机构empty_bottleBoolean必选是否空瓶:0 是,1 不是product_idString可选产品类型 IDuidString可选高频编码tidString可选超高频编码chip_statusBoolean必选是否改造:0 未改造,1 已改造location_source_idString可选当前归属机构 IDis_loseBoolean必选是否丢失:0 丢失,1 未丢失old_bottleBoolean必选是否旧瓶design_thicknessNumber必选设计壁厚result_codeString可选检测结果audit_remarkString可选审批备注deadline_timeDateTime必选使用年限check_in_timeDateTime必选录入日期scrap_timeDateTime可选报废日期analysis_statusString必选统计状态值:inform 已提交待审批,using 在用,scrapped 报废check_statusBoolean必
收藏
编号:342829987
类型:共享资源
大小:57.56KB
格式:DOCX
上传时间:2023-01-14
8
金贝
- 关 键 词:
-
2022
质量
安全
追溯
系统
部分
数据
接口
- 资源描述:
-
气瓶质量安全追溯系统
第 2 部分:数据接口
目 次
1 范围 1
2 规范性引用文件 1
3 术语和定义 1
4 缩略语 1
5 总体要求 2
6 接口消息格式 2
7 接口基本功能和参数 3
参考文献 11
I
气瓶质量安全追溯系统 第 2 部分:数据接口
1 范围
本文件规定了气瓶质量安全追溯系统数据接口的总体要求、接口消息格式、接口基本功能和参数。本文件适用于液化石油气气瓶和液化二甲醚气瓶的气瓶质量安全追溯系统的数据接口。
2 规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件, 仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T 13000 信息技术 通用多八位编码字符集(UCS)
RFC 2616 超文本传输协议1.1(Hypertext Transfer Protocol—HTTP/1.1)
RFC 4627 JSON 应用与媒体类型[The application/json Media Type for JavaScript Object Notation(JSON)]
3 术语和定义
下列术语和定义适用于本文件。
3.1
气瓶信息化标签
实现气瓶生命周期中充装验证和追溯的信息化媒介。
3.2
编码字符集
一组明确的规则,它建立字符集和该字符集内的字符与其位组之间一一对应的关系。[来源:GB/T 1988-1998,4.6]
4 缩略语
下列缩略语适用于本文件。
GTM:格林威治时间(Greenwich Mean Time) HTML:超文本置标语言(Hyper Text Markup Language)
HTTP:超文本传输协议(Hyper Text Transfer Protocol)
HTTPS:超文本传输安全协议(Hyper Text Transfer Protocol over Secure Socket Layer 或Hypertext Transfer Protocol Secure)
ID:标识符(Identifier)
JSON:轻量级的数据交换格式(JavaScript Object Notation) MIME:多用途互联网邮件扩展(Multipurpose Internet Mail Extensions)
1
5 总体要求
5.1 通信协议
应采用符合RFC 2616的HTTP或HTTPS。
5.2 接口描述
宜使用标准化的或比较通用的文本描述语言,如JSON(RFC4627)。
5.3 编码字符集
应符合GB/T 13000的要求。
5.4 数据类型
气瓶质量安全追溯系统数据接口应覆盖所能支持数据类型,包括:
——字符串型(String);
——数字型(Number);
——时间型(DateTime);
——对象型(Object);
——数组型(Array);
——布尔型(Boolean);
——空(NULL)。
注:对“时间”类信息,以“1970年1月1日,00:00:00(GTM时间)”作为基准起始时间。
6 接口消息格式
6.1 请求消息格式
6.1.1 消息格式
请求消息由请求头和请求参数组成。应使用HTTP规定的POST请求方法。
6.1.2 请求头
不同接口具有统一请求头,请求头的名称及其含义描述应符合表1的规定。
表1 请求头
名称
描述
必选/可选
Host
指定请求的服务器的域名和端口号
必选
Connection
表示是否需要持久连接
必选
Accept
表示接受所接收的内容类型
必选
Content-Type
请求的与实体对应的MIME信息
必选
Content-Lentgh
请求的内容长度
必选
2
表 1 (续)
名称
描述
必选/可选
Cookie
HTTP请求发送时,会把保存在该请求域名下的所有cookie
值一起发送给网站服务器
可选
User-Agent
内容包含发出请求的用户信息
可选
Token
访问连接的密钥信息
可选
6.1.3 请求参数
请求参数格式见示例列表形式,根据不同接口功能,其请求参数不同。
示例:
参数名
数据类型
必选/可选
描述
给出该字段所代表的参数名
用于描述数据的数据类型
描述该参数是否为必选
对参数的描述及补充说明
-
-
-
-
6.2 响应消息格式
6.2.1 消息格式
响应消息由响应头和响应消息参数组成。应使用HTTP规定的POST请求方法。
6.2.2 响应头
不同接口具有同一响应头,响应头的名称及其含义描述应符合表2的规定。
表2 响应头
名称
描述
必选/可选
Content-Type
请求的与实体对应的MIME信息
必选
Content-Length
请求的内容长度
必选
Date
服务器消息发出的时间
可选
Server
服务器软件名称
可选
6.2.3 响应参数
响应消息参数格式见示例列表形式,根据不同接口功能,其响应消息参数不同。
示例:
参数名
数据类型
必选/可选
描述
给出该字段所代表的参数名
用于描述数据的数据类型
描述该参数是否为必选
对参数的描述及补充说明
-
-
-
-
7 接口基本功能和参数
7.1 接口流程
企业平台向监管平台上报数据或请求数据的接口流程应符合图1,接口的流程如下:
a) 企业平台发出请求,上报数据或请求数据;
b) 监管平台对该次请求进行处理;
3
c) 处理后由监管平台向企业平台返回处理结果。
图1 接口流程
7.2 初始化连通接口
7.2.1 功能
用于企业平台和监管平台间建立初始化连通。
7.2.2 请求参数
初始化连通请求参数应符合表3的规定。
表3 初始化连通请求参数
参数名
数据类型
必选/可选
描述
app_id
String
必选
接入方ID
app_key
String
必选
接入方功能板块信息
app_secret
String
必选
接入方密钥
7.2.3 响应消息参数
初始化连通响应消息参数应符合表4的规定。
表4 初始化连通响应消息参数
参数名
数据类型
必选/可选
描述
status
Number
必选
本次请求处理状态码
msg
String
必选
本次请求处理结果描述
access_token
String
必选
接入获取到的密钥
expries
Number
必选
密钥过期时间
4
7.3 请求类接口
7.3.1 请求类接口列表
请求类接口列表应符合表5的规定。
表5 请求类接口列表
中文名称
英文名称
必选/可选
气瓶基本信息
product
必选
气瓶充装信息
fill
必选
气瓶检验信息
check
可选
气瓶信息化标签信息
tag
可选
7.3.2 请求类接口基本功能和参数
7.3.2.1 气瓶基本信息
7.3.2.1.1 功能
用于企业平台查询监管平台内气瓶基本信息。
7.3.2.1.2 请求参数
气瓶基本信息请求参数应符合表6的规定。
表6 气瓶基本信息请求参数
参数名
数据类型
必选/可选
描述
inner_code
String
必选
查询气瓶的单位内编码
7.3.2.1.3 响应消息参数
气瓶基本信息响应信息参数应符合表7的规定。
表7 气瓶基本信息响应消息参数
名称
数据类型
必选/可选
描述
pro_variety
String
必选
设备品种
pro_name
String
必选
产品名称
pro_no
String
必选
气瓶生产编号
fill_media
Number
必选
充装介质:0 液化石油气,1 二甲醚,2 氧气,3 二氧
化碳,4 溶解乙炔
make_unit
String
必选
制造单位
make_time
DateTime
必选
生产日期
work_pressure
Number
必选
公称工作压⼒ (MPa)
volume
Number
必选
容积(L)
check_time
DateTime
必选
最近⼒ 次检验⼒ 日期(新瓶该值填写出厂日期)
5
表7 (续)
名称
数据类型
必选/可选
描述
next_check_time
DateTime
必选
下次检验日期(液化石油气瓶顺延 4 年气瓶下一次需要送检验站检验的日期)
regist_code
String
可选
气瓶使 登记代码
change_event
String
可选
变更情况(主要记录产权过户日志)
memo
String
可选
备注
inner_code
String
必选
单位内编号
stamp_make_unit
String
可选
气瓶钢印制造单位名称
pro_uuid
String
必选
产品唯一性编码
chip_id
String
可选
芯片 id(每一个批次生成的登记证编号)
location
String
可选
归属地(客户、门店、气站、检测机构):0001 门店, 0002 气站,0003 企业,0004 检验机构,005 移动库,
006 客户
status
String
必选
气瓶状态[在用(已检测)、停用(待检测)、报废]: submit 新瓶提交,using 在用(已检测),stop 停用(待
检测),scrapped 报废
check_organization
String
可选
检测机构
empty_bottle
Boolean
必选
是否空瓶:0 是,1 不是
product_id
String
可选
产品类型 ID
uid
String
可选
高频编码
tid
String
可选
超高频编码
chip_status
Boolean
必选
是否改造:0 未改造,1 已改造
location_source_id
String
可选
当前归属机构 ID
is_lose
Boolean
必选
是否丢失:0 丢失,1 未丢失
old_bottle
Boolean
必选
是否旧瓶
design_thickness
Number
必选
设计壁厚
result_code
String
可选
检测结果
audit_remark
String
可选
审批备注
deadline_time
DateTime
必选
使用年限
check_in_time
DateTime
必选
录入日期
scrap_time
DateTime
可选
报废日期
analysis_status
String
必选
统计状态值:inform 已提交待审批,using 在用,
scrapped 报废
check_status
Boolean
必
展开阅读全文
金锄头文库所有资源均是用户自行上传分享,仅供网友学习交流,未经上传用户书面授权,请勿作他用。