仓储-省级开放数据接口清单

仓储-省级开放数据接口清单

1、版本历史

日期	版本号	作者	备注
2021.04.12	1.0	侯育帅	新版本发布

2、通用原则

HTTP Method和对应的操作

### HTTP Method和对应的操作

| HTTP Method | 对应操作                         |
| ----------- | ---------------------------- |
| GET         | 请求单个资源或请求一个资源集合              |
| POST        | 创建新资源；也可以用来执行复杂条件和结构的资源查询    |
| PUT         | 更新已存在资源的属性；也可以用来调用已存在资源的某些操作 |
| DELETE      | 删除一个已存在的资源                   |

全局响应状态码说明

状态码	说明
200	操作成功
1001	认证失败
1002	参数不合法
1003	服务器异常

请求参数说明

• 分页，起始页 从1开始
• 分页，每页的条数不得超过30条；

返回结果

所有返回结果以 JSON 格式返回；接口返回一共有三种情况：

1. 操作成功后返回，范例：

   {
     "code": "200",//状态码
     "msg": "SUCCESS"//信息
   } 
   

2. 成功返回数据，范例：

   {
     "data": {//数据
       "name": "名称",
       "age": "18"
     },
     "code": "200",//状态码
     "msg": "SUCCESS"//信息
   }
   

3. 错误返回，范例：

   {
     "code": "1001",//错误状态码
     "msg": "参数不合法"//错误信息
   }
   

接口认证

header 中增加 access_token头信息数据
或者url中携带access_token请求参数

常量信息表

• 仓库信息表

仓库名称	仓库PK
待确定同步那几个仓库的备件

• 装备备件状态信息表

code	说明
01	未启用
02	在用
03	待用
04	待修
05	待检
06	返厂
07	报废
08	外销
09	运输中
10	检修中
11	维修中
12	待报废

• 入库类型信息表

code	说明
01	采购入库
02	调拨入库
03	借用入库
04	送检入库
05	送修入库
06	盘点入库

• 出库类型信息表

code	说明
01	调拨出库
02	借用出库
03	送检出库
04	送修出库
05	盘点出库
06	报废出库

3、接口清单

3.1、生成条码

请求说明

请求方式：GET

请求URL ：/equipment/registerSystemApi/generateQrCodes.do

请求参数

字段	是否必须	字段类型	字段说明
categoryCode	是	string	类别码Code(九位)
batchCode	否	String	批次号(两位不足补零)
productionDate	否	String	yyyy-MM-dd
codeCount	是	number	生成条码数量

返回示例说明

{
  code:"200",
  msg:'success',
  data:["条码1","条码1",...]
}

3.2、登记系统备件台账信息同步至天元

请求说明

请求方式：POST

请求URL ：/equipment/registerSystemApi/saveOrUpDateMateriel.do

请求参数

字段	是否必须	字段类型	字段说明
qrCodes	是	Array	装备条码集合
instockDate	否	String	入库时间 yyyy-MM-dd
wareHousePk	否	string	所在仓库pk
materielStatus	是	String	当前备件状态，值见常量表
contractId	否	number	合同id
purchaseUnit	否	String	采购单位
managementType	否	String	业务类型，值见常量表
inType	否	String	入库类型，值见常量表
currentUnit	是	String	当前备件所在单位
history	是	boolean	是否历史数据

返回示例说明

{
  code:"200",
  msg:'success'
}

3.3、登记系统调拨信息同步至天元

请求说明

请求方式：POST

请求URL ：/equipment/registerSystemApi/saveTransfersInfos.do

请求参数

字段	是否必须	字段类型	字段说明
qrCodes	是	Array	装备条码集合
applyUnit	是	string	申请单位
applyUserId	是	string	申请人userId
applyDate	是	String	申请时间yyyy-MM-dd
totalPrice	是	number	总价格
history	是	boolean	是否历史数据

返回示例说明

{
  code:"200",
  msg:'success'
}

3.4、天元入库信息同步至登记系统

请求说明

请求方式：POST

请求URL ：登记系统提供

请求参数

字段	是否必须	字段类型	字段说明
qrCodes	是	Array	装备条码集合
instockDate	否	String	入库时间 yyyy-MM-dd
wareHousePk	否	string	所在仓库pk
materielStatus	是	String	当前备件状态，值见常量表
contractId	否	number	合同id
purchaseUnit	否	String	采购单位
managementType	否	String	业务类型，值见常量表
inType	否	String	入库类型，值见常量表
currentUnit	是	String	当前备件所在单位

3.5、天元调拨信息同步至登记系统

请求说明

请求方式：POST

请求URL ：登记系统提供

请求参数

字段	是否必须	字段类型	字段说明
qrCodes	是	Array	装备条码集合
applyUnit	是	string	申请单位
applyUserId	是	string	申请人userId
applyDate	是	String	申请时间yyyy-MM-dd
totalPrice	是	number	总价格
history	是	boolean	是否历史数据