物品档案接口
1. 获取耗材分类列表
请求地址
text
GET /consumable/category参数说明
耗材分类查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"id": 49087,
"code": "10010",
"name": "二级分类",
"remark": "类别",
"createdTime": "1601011346",
"parentCategory": {
"id": 3126,
"code": "sys001",
"name": "物品分类",
"remark": "系统自动添加",
"createdTime": "1483610796"
},
"createdUser": {
"id": 6261,
"userName": "shangde@123.com",
"name": "尚德",
"isAdministrator": true,
"deleted": false,
"pushClientId": "2690078246ca8575de3a52f5f95a7a2f",
"relatedEmployeeId": "dbb5aa65-8f1c-4d69-8366-49823fe978a3"
},
"parentCode": "sys001"
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量，指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0 |
| results | 符合查询条件的耗材分类详情集合 |
| meta | 其他信息 |
2. 创建耗材分类
请求地址
text
POST /consumable/category请求示例
json
{
"remark":"备注",
"code":"36668",
"name":"新分类",
"parentCode":"sys001"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 耗材分类编码 |
| Name | 是 | 耗材分类名称 |
| remark | 否 | 备注 |
| parentCode | 否 | 耗材分类父级编码 |
返回结果
json
{}对于成功更新的请求，该接口仅返回HTTP 200 OK
3. 更新耗材分类
请求地址
text
PUT /consumable/category/{code}
POST /consumable/category/{code}/put对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址
请求示例
json
{
"remark":"备注",
"code":"36668",
"name":"新分类",
"parentCode":"sys001"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 耗材分类编码 |
| Name | 是 | 耗材分类名称 |
| remark | 否 | 备注 |
| parentCode | 否 | 耗材分类父级编码 |
返回结果
json
{}对于成功更新的请求，该接口仅返回HTTP 200 OK
4. 删除耗材分类
请求地址
text
DELETE /consumable/category/{code}
POST /consumable/category/{code}/delete对于不支持DELETE请求的网络环境，请尝试使用备份的POST请求地址
返回结果
json
{}对于成功删除的请求，该接口仅返回HTTP 200 OK
附加信息
下列条件之一成立时，无法对指定的耗材分类进行删除操作
该耗材分类下存在子耗材分类信息
该耗材分类下存在物品信息
5. 获取耗材物品
请求地址
text
GET /consumable?categoryCode=xxx参数说明
耗材分类查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
| 参数 | 是否必须 | 说明 |
|---|---|---|
| categoryCode | 是 | 耗材分类编码 |
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"disabled": false,
"remark": "消耗快",
"createdTime": "1601024239",
"createdByName": "shangde@123.com",
"id": 120972,
"code": "26886859",
"name": "牛奶",
"barcode": "26886859",
"logo": "蒙牛",
"specification": "275ml",
"measureUnit": "盒",
"safeStockUpperLimit": 500,
"safeStockLowerLimit": 0,
"picturePath": "/MediaResources/4506/Consumable/20200925/f5226f30f22143d8895fcffe42eca229.jpg",
"thumbnailPath": "/MediaResources/4506/Consumable/20200925/db8e3714f51b4e0fb85396b1be7a82a3.jpg",
"categoryName": "二级分类",
"categoryCode": "10010",
"unitPrice": 3.00
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量，指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0 |
| results | 符合查询条件的耗材物品详情集合 |
| meta | 其他信息 |
6. 创建耗材物品
请求地址
text
POST /consumable请求示例
json
{
"measureUnit":"盒",
"specification":"220ml",
"logo":"王老吉",
"safeStockUpperLimit":"100",
"remark":"备注",
"categoryCode":"10010",
"unitPrice":"2.5",
"name":"王老吉",
"code":"166566468",
"safeStockLowerLimit":"0",
"disabled":"0",
"barcode":"166566468",
"thumbnailMediaResourceNo": "",
"pictureMediaResourceNo": ""
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Specification | 否 | 规格型号 |
| MeasureUnit | 否 | 计量单位 |
| logo | 否 | 品牌商标 |
| safeStockUpperLimit | 否 | 安全库存上限 |
| safeStockLowerLimit | 否 | 安全库存下限 |
| remark | 否 | 备注 |
| categoryCode | 否 | 耗材分类编码 |
| unitPrice | 否 | 默认单价 |
| name | 是 | 物品名称 |
| code | 是 | 物品编码 |
| barcode | 是 | 备商品码 |
| disabled | 是 | 是否禁用（0:不禁用、1:禁用） |
| pictureMediaResourceNo | 否 | 图片编码 |
| thumbnailMediaResourceNo | 否 | 缩略图编码 |
返回结果
json
{}对于成功新增的请求，该接口仅返回HTTP 200 OK
7. 更新耗材物品
请求地址
text
PUT /consumable/{code}
POST /consumable/{code}/put对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址
请求示例
json
{
"measureUnit":"盒",
"specification":"220ml",
"logo":"王老吉",
"safeStockUpperLimit":"100",
"remark":"备注",
"categoryCode":"10010",
"unitPrice":"2.5",
"name":"王老吉",
"code":"166566468",
"safeStockLowerLimit":"0",
"disabled":"0",
"barcode":"166566468",
"thumbnailMediaResourceNo": "",
"pictureMediaResourceNo": ""
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Specification | 否 | 规格型号 |
| MeasureUnit | 否 | 计量单位 |
| logo | 否 | 品牌商标 |
| safeStockUpperLimit | 否 | 安全库存上限 |
| safeStockLowerLimit | 否 | 安全库存下限 |
| remark | 否 | 备注 |
| categoryCode | 否 | 耗材分类编码 |
| unitPrice | 否 | 默认单价 |
| name | 是 | 物品名称 |
| code | 是 | 物品编码 |
| barcode | 是 | 备商品码 |
| disabled | 是 | 是否禁用（0:不禁用、1:禁用） |
| pictureMediaResourceNo | 否 | 图片编码 |
| thumbnailMediaResourceNo | 否 | 缩略图编码 |
返回结果
json
{}对于成功更新的请求，该接口仅返回HTTP 200 OK
8. 删除耗材物品
请求地址
text
DELETE /consumable/{code}
POST /consumable/{code}/delete对于不支持DELETE请求的网络环境，请尝试使用备份的POST请求地址
返回结果
json
{}对于成功删除的请求，该接口仅返回HTTP 200 OK
附录
1. 支持的查询参数
如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。
分页
skip={数字} 跳过指定条数的记录数
take={数字}取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）
include=total 需要返回记录总数
排序
orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age
条件过滤
不等于
{属性名称}!={值} 如：Id!=1
大于等于
>{属性名称}={值} 如：>Id=1
大于
{属性名称}>={值} 如：Id>=1
小于
<{属性名称}={值} 如：<Id=1
小于等于
{属性名称}<={值} 如：Id<=1
In
{属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3
Between
{属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3
字符串包含指定字符
{属性名称}Contains={值} 如：nameContains=abc
字符串以指定字符开头
{属性名称}StartsWith={值} 如：nameStartsWith=abc
字符串以指定字符结尾
{属性名称}EndsWith={值} 如：nameEndsWith=abc
2. 数据实体格式
1. 耗材分类数据对象格式
| 属性名称 | 说明 |
|---|---|
| parentCode | 上级耗材分类编码 |
| id | 耗材分类Id |
| code | 耗材分类编码 |
| name | 耗材分类名称 |
| remark | 备注 |
| createdTime | 创建时间（时间戳格式） |
| parentCategory | 上级分类详情 |
| createdUser | 创建人详情 |
上级分类详情
| 属性名称 | 说明 |
|---|---|
| id | 耗材分类Id |
| code | 耗材分类编码 |
| name | 耗材分类名称 |
| remark | 备注 |
| createdTime | 创建时间（时间戳格式） |
创建人详情
| 属性名称 | 说明 |
|---|---|
| id | 创建人id |
| userName | 创建人账号 |
| name | 创建人名称 |
| isAdministrator | 是否超级管理员 |
| deleted | 是否被删除了 |
| pushClientId | 推送ClientId |
| relatedEmployeeId | 关联的员工id |
2. 耗材物品数据对象格式
| 属性名称 | 说明 |
|---|---|
| remark | 备注 |
| createdTime | 创建时间（时间戳格式） |
| createdByName | 创建人 |
| id | 物品id |
| code | 物品编码 |
| name | 物品名称 |
| barcode | 商品码 |
| picturePath | 物品图片路径 |
| thumbnailPath | 物品缩略图路径 |
| logo | 品牌商标 |
| specification | 规格型号 |
| measureUnit | 单位 |
| safeStockUpperLimit | 安全库存上限 |
| safeStockLowerLimit | 安全库存下限 |
| categoryName | 耗材分类名称 |
| categoryCode | 耗材分类编码 |
| unitPrice | 默认单价 |
| disabled | 是否已禁用 |