TYNZYC 0103-2023 云南省中药材追溯体系 第3部分：数据接口规范

ICS65.020.99CCSB00 T/YNZYC云南省中药材种植养殖行业协会团体标准T/YNZYC0103—20233YunnanProvincialTraceabilitySystemofTraditionalChineseMedicinalMaterialsPart3:DataInterfaceSpecification2023-12-30发布 2023-12-30实施云南省中药材种植养殖行业协会  发布T/YNZYC0103T/YNZYC0103—2023II前 言本文件按照GB/T1.1—2020《标准化工作导则 第1部分：标准化文件的结构和起草规则》的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本文件由云南省中药材种植养殖行业协会提出并归口。本文件起草单位：云南省中药材种植养殖行业协会、云南省商务厅、云南钰津供应链科技有限公司T/YNZYC0103T/YNZYC0103—2023PAGEPAGE10云南省中药材追溯体系第3部分：数据接口规范范围本标准规定了云南省中药材追溯体系的术语和定义、追溯数据接口的总体要求、接口类型、接口关系、接口基本功能和参数等内容。本标准适用于构建云南省中药材追溯体系数据接口规范。规范性引用文件（包括所有的修改单）适用于本文件。GB/T2260中华人民共和国行政区划代码GB/T7408数据元和交换格式信息交换日期和时间表示法GB/T38159重要产品追溯追溯体系通用要求中国药典术语和定义下列术语和定义适用于本文件。subjectcode下列缩略语适用于本文件。HTTPS:超文本传输安全协议(HyperTextTransferProtocoloverSecureSocketLayer或HypertextTransferProtocolSecure)ID:标识符(Identifier)JSON:轻量级的数据交换格式(JavaScriptObjectNotation)中药材追溯体系数据接口总体要求通信协议应采用符合IETFRFC2818规定的HTTPS协议作为底层承载协议。接口描述接口命名使用通用的驼峰命名方式，接口文本描述语言采用通用的JSON格式。编码字符集应采用IETFRFC3629规定的UTF-8字符集。数据类型中药材追溯系统数据接口覆盖所能支持数据类型，包括：——字符串型（String）——数字型（Number）——时间型（Datetime）——对象型（Objeck）——数组型（Array）——布尔型（Boolean）——空（NULL）中药材追溯体系数据接口类型中药材追溯系统数据接口主要包括下列类型：——主体信息类，包括但不限于主体信息类参数；——资料信息类，包括但不限于资料数据类。中药材追溯体系数据接口关系图1中药材追溯体系数据接口关系图中药材追溯体系数据接口基本功能和参数主体信息类接口功能用于监管平台查询企业基本备案信息。参数主体信息类参数见表1。表1主体信息类参数字段名含义数据类型必选/可选说明En_name企业名称String必选通过统一社会信用代码获取企业注册名称Unif_soci_cred_code社会统一信用代码String必选18位统一社会信用代码Legal_User_Name法人姓名String必选-Legal_Id_Card法人身份证号String必选企业法人身份证信息Contacts_Name联系人String必选-Contact_phone联系电话String必选按GB/T2260中华人民共和国行政区划代码标准填写）Mailbox邮箱String必选-Office_address地址String必选具体到省、市、区、乡enterpriseProperty企业属性String必选依据中药材属性将企业划分为药材种植和药材养殖型企业En_Operation业务类型String必选具体到种苗繁育、药材种植、产地初加工、药材经销En_img资质证照array必选将图片转为Base64编码格式存储Logo企业logoarray必选将图片转为Base64编码格式存储Account_opening_application_form开户申请表String必选将图片转为Base64编码格式存储基地档案类接口功能用于监管平台查询企业基地基本信息。基地基本信息请求参数基地基本信息请求参数应符合表2的规定。表2基地基本信息请求参数字段名含义数据类型必选/可选说明BaseName基地名称String必选-CreatYear创建年份Number必选-BaseType基地类型Number必选1-种苗繁育；2-药材种植MedicineName植物名称String必选按照《中国药典》中的品名要求填写响应参数基地基本信息响应参数应符合表3的规定。表3基地基本信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功基地环境信息请求参数基地环境信息请求参数应符合表4的规定。表4基地环境信息请求参数字段名含义数据类型必选说明baseCode基地编号String必选-响应参数基地环境信息响应参数应符合表5的规定。表5基地环境信息响应参数字段名含义数据类型必选说明baseCode基地编号String必选-soilId土壤类型Number必选-soilName土壤名称String必选-environmentCode环境编号String必选-phValuepH值String必选-headwaters水源Number必选1-井水；2-河流frostlessDay无霜期（天）String必选-accumu积温（摄氏度）String必选-hottest最热月平均气温String必选-hightTemperature土壤质地年绝对最高气温String必选-soilTexture土壤质地Number必选1-壤土；2-沙土；3-黏土organicContent有机质含量String必选-annualPre年降水量（单位mm）String必选-averageTem年平均气温String必选-coldestTem最冷月平均气温String必选-minimumTem年绝对最低气温String必选-sunshine年日照时数（单位小时）String必选-picUrl图片地址array必选-picCode图片来源String必选-基地操作人员信息请求参数基地操作人员信息请求参数应符合表6的规定。表6基地操作人员信息请求参数字段名含义数据类型必选说明baseCode基地编号String必选-plantArea种植面积String必选单位：亩trueName姓名String必选-isPoverty是否贫困户Number必选操作员当前是否为贫困帮扶户（1-是；2-否）idCard身份证String必选-phone手机号String必选-type类型Number必选1-带动就业；2-带动种植响应参数基地操作人员信息响应参数应符合表7的规定。表7基地操作人员信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功基地管理人员信息请求参数基地管理人员信息请求参数应符合表8的规定。表8基地管理人员信息请求参数字段名含义数据类型必选说明trueName真实姓名String必选-phone手机号String必选-响应参数基地管理人员信息响应参数应符合表9的规定。表9基地操作人员信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功追溯信息类接口功能用于监管平台查询企业追溯基本信息，不限于种源信息、种植信息、采收信息、加工信息、监测信息、销售信息、仓储信息、运输信息等。种源信息请求参数种源信息请求参数应符合表10的规定。表10种源信息请求参数字段名含义数据类型必选说明baseCode基地编号String必选-baseName基地名称String必选-medicineName药材名称String必选-latinName拉丁名String必选-pattern种植方式Number必选1-轮作；2-兼做；3-套种；4-直播；5-移栽；6-其他propagatingType繁殖方式Number必选1-分割繁组培繁殖provenanceCode种源批号String必选-响应参数种源信息响应参数应符合表11的规定。表11种源信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功种植信息请求参数种植信息请求参数应符合表12-13的规定。表12种植信息-添加任务请求参数字段名含义数据类型必选说明plantationCode种植批号String必选关联种植信息的种植批次号missionCode任务编号String必选-plantationType任务类型Number必选1-播种；2-除草；3-移栽；4-虫害防治；5-灌溉；6-施肥；7-病害防治；8-种子、种苗处理；9-整地；10-其他表13种植信息-任务记录请求参数字段名含义数据类型必选说明accomplishment完成量String必选-trueName操作员姓名String必选-baseOperatorId操作员IDNumber必选-accomplishTime完成时间datetime必选符合GB/T7408中的日期格式要求picUrl图片array必选-响应参数种植信息响应参数应符合表14-15的规定。表14种植信息添加任务响应参数字段名含义数据类型必选说明Code响应状态码Number必选-TaskWeeding任务列表object必选查看任务列表的返回参数说明文档plantationMission种植任务object必选-enOperationList物料集合array必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功表15种植信息任务记录响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功物料信息请求参数物料信息请求参数应符合表16的规定。表16物料信息请求参数字段名含义数据类型必选说明materialName物料名称String必选-materialUrl物料缩略图String必选-materialType类型Number必选16-其他vender生产厂家String必选-province省份String必选-city市String必选-district区String必选-address详细地址String必选详细地址baseCode基地编号String必选-baseName基地名称String必选-响应参数物料信息响应参数应符合表17的规定。表17物料信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功采收信息请求参数采收信息请求参数应符合表18-19的规定。表18采收信息药材采收（采收任务）请求参数字段名含义数据类型必选说明processDictId采收部位字典IDNumber必选-recoveryWay采收方式Number必选1-人工采收；2-机器采收recoveryName采收部位String必选-totalArea采收总面积String必选单位：亩baseCode基地编号String必选-表19采收信息药材采收（采收记录）请求参数字段名含义数据类型必选说明baseCode基地编号String必选-recoveryCode采收批号String必选-trueName操作员String必选-baseOperatorId操作员IDString必选-recoveryNum采收产量String必选保留两位小数，单位：kgrecoveryArea采收面积String必选单位：亩recoveryTime采收时间String必选符合GB/T7408中的日期格式要求picUrl图片array必选将图片转为Base64编码格式存储表20采收信息种源采收（新增种源）请求参数字段名含义数据类型必选说明recoveryWay采收方式Number必选1-人工采收；2-机器采收seedType种源类型Number必选1-种子；2-种苗totalArea采收总面积String必选单位：亩baseCode基地编号String必选-weightUnit产量单位Number必选0-Kg；1-株growingYear采收年限String必选-表21采收信息种源采收（采收记录）请求参数字段名含义数据类型必选说明baseCode基地编号String必选-recoveryCode采收批号String必选-trueName操作员String必选baseOperatorId操作员IDString必选recoveryNum采收产量String必选单位：Kg（保留两位小数）/株recoveryArea采收面积String必选单位：亩recoveryTime采收时间String必选符合GB/T7408中的日期格式要求picUrl图片array必选将图片转为Base64编码格式存储响应参数采收信息请求参数应符合表22的规定。表22采收信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功加工信息请求参数加工信息请求参数应符合表23-24的规定。表23加工信息（加工任务）请求参数字段名含义数据类型必选说明freshWarehouseCode鲜货批号String必选-medicineName药材名称String必选-processType加工类型Number必选1-内部原料；2-外部原料weight原料重量String必选单位：Kg表24加工信息（任务记录）请求参数字段名含义数据类型必选/可选说明medicineProcessCode加工批号String必选-processYield加工产量String必选单位：KgtechnologyDictId加工工艺ID列表array必选-响应参数加工信息响应参数应符合表25的规定。表25加工信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自动化报告参数String必选描述脚本执行内容为操作成功仓储信息请求参数仓储信息请求参数应符合表26-28的规定。表26仓储信息（鲜货入库）请求参数字段名含义数据类型必选说明freshWarehouseCode外部鲜货编号String必选-medicineName药材名称String必选按照中国药典中的品名要求填写recoveryNum采收产量String必选单位：Kg（保留两位小数）/株recoveryName采收部位String必选-startTime任务开始时间String必选符合GB/T7408中的日期格式要求accomplishTime完成时间String必选符合GB/T7408中的日期格式要求sourceAddr来源具体途径String必选-enterpriseCode企业编号String必选-freshAddr鲜货产地String必选详细地址表27仓储信息（药材存储）请求参数字段名含义数据类型必选说明enterpriseCode企业编码String必选-medicineProcessCode加工批号String必选-medicineName药材名称Number必选按照中国药典中的品名要求填写processName加工等级String必选Num分包数Number必选Size包装规格Number必选-plantName植物名称String必选按照中国药典中的品名要求填写表28仓储信息（种源入库）请求参数字段名含义数据类型必选说明seedType种源类型Number必选1-种子；2-种苗medicineName药材名称String必选按照中国药典中的品名要求填写weight重量String必选单位：Kg（保留两位小数）/株comment备注String必选-startTime任务开始时间String必选符合GB/T7408中的日期格式要求accomplishTime完成时间String必选符合GB/T7408中的日期格式要求sourceAddr种源来源具体途径String必选-seedAddr种源产地String必选详细地址weightUnit重量单位Number必选0-Kg；1-株响应参数仓储信息响应参数应符合表29的规定。表29仓储信息响应参数字段名含义数据类型必选说明Code响应状态码Number必选-RST复位Number必选用于将指定的中断屏蔽位复位为逻辑0，指令形式：RST1DescUI自