15 共享工具屋API
API列表
编号 | API名称(通用) | 备注 |
---|---|---|
15.0.1 | 获取当前小区共享工具屋信息 |
编号 | API名称(后台) | 备注 |
---|---|---|
15.1.1 | 创建共享工具屋 | |
15.1.2 | 编辑共享工具屋 | |
15.1.3 | 共享工具屋详情 | |
15.2.1 | 工具列表 | |
15.2.2 | 新增工具 | |
15.2.3 | 工具详情 | |
15.2.4 | 编辑工具信息 | |
15.2.5 | 工具上架/下架 | |
15.2.6 | 删除工具 | |
15.3.1 | 新增工具类型 | |
15.3.2 | 工具类型列表 | |
15.4.1 | 借还记录列表 | |
15.4.2 | 借还详情 | |
15.4.3 | 后台归还 | |
15.4.4 | 后台未归还 | |
15.5.1 | 黑名单新增与修改 | |
15.5.2 | 黑名单列表 | |
15.5.3 | 黑名单移除 |
编号 | API名称(app端) | 备注 |
---|---|---|
15.11.1 | app工具列表 | |
15.12.1 | 用户借还初始状态 | |
15.12.2 | 用户当前的借出记录 | |
15.12.3 | 保存借出列表 | |
15.12.4 | 借出开门成功后调用 | |
15.12.5 | 保存确认借出清单 | |
15.12.6 | 当前借出列表 | |
15.12.7 | 当前归还列表 | |
15.12.8 | 归还开门成功后调用 | |
15.12.9 | 借出开门前验证 | |
15.12.10 | 归还开门前验证 |
15.0.1: 获取当前小区共享工具屋信息
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/toolshed/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | LONG | 是 | 项目id |
请求Body描述(非Form表单数据)
{
"communityId":369
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
communityId | DATA | LONG | 是 | 项目id |
address | DATA | STRING | 是 | 工具房地址 |
doorId | DATA | STRING | 是 | 门禁id |
toolshedId | DATA | LONG | 是 | 工具房id |
返回结果示例
{
"code": 200,
"data": {
"current": 1,
"orders": [],
"pages": 1,
"records": [
{
"address": "C门出口处",
"communityId": 21441118,
"doorId": 1416375054,
"toolshedId": 2
}
],
"searchCount": true,
"size": 10,
"total": 1
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.1.1: 创建共享工具屋
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/toolshed/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | LONG | 是 | 项目id |
doorId | BODY | LONG | 是 | 门禁id |
address | BODY | LONG | 是 | 工具屋地址 |
请求Body描述(非Form表单数据)
{
"communityId":369,
"doorId":"A123",
"address":"A门出口处"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.1.2: 编辑共享工具屋
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/toolshed/edit
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | BODY | LONG | 是 | 工具屋id |
doorId | BODY | LONG | 否 | 门禁id |
address | BODY | LONG | 否 | 工具屋地址 |
请求Body描述(非Form表单数据)
{
"toolshedId":1,
"doorId":"A123",
"address":"A门出口处"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.1.3: 共享工具屋详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/toolshed/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | BODY | LONG | 是 | 工具屋id |
请求Body描述(非Form表单数据)
{
"toolshedId":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
communityId | DATA | LONG | 是 | 项目id |
address | DATA | STRING | 是 | 工具房地址 |
doorId | DATA | STRING | 是 | 门禁id |
toolshedId | DATA | LONG | 是 | 工具房id |
返回结果示例
{
"code": 200,
"data": [
{
"address": "B门出口处",
"communityId": 369,
"doorId": "B123",
"toolshedId": 1
}
],
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.2.1: 工具列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | BODY | LONG | 否 | 工具屋Id |
communityId | BODY | LONG | 否 | 项目id(工具屋唯一可用) |
请求Body描述(非Form表单数据)
{
"toolshedId":1
}
或:
{
"communityId":21441118
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
current | DATA | INTEGER | 是 | 当前页数 |
total | DATA | INTEGER | 是 | 数据条数 |
pages | DATA | INTEGER | 是 | 总页数 |
size | DATA | INTEGER | 是 | 每页数量 |
toolId | records | LONG | 是 | 工具id |
toolshedId | records | LONG | 是 | 工具房id |
categoryId | records | LONG | 是 | 工具类型id |
toolName | records | STRING | 是 | 工具名称 |
toolCode | records | STRING | 是 | 工具编码 |
toolImg | records | STRING | 是 | 工具图片 |
useImg | records | STRING | 是 | 使用方法图片 |
stockCount | records | INTEGER | 是 | 总库存 |
remainCount | records | INTEGER | 是 | 剩余库存 |
remark | records | STRING | 是 | 备注 |
status | records | INTEGER | 是 | 状态 1-上架 2-下架 |
createTime | records | STRING | 是 | 创建时间 |
creatorId | records | INTEGER | 是 | 创建人id |
badCount | records | INTEGER | 是 | 损坏数量 |
loseCount | records | INTEGER | 是 | 丢失数量 |
otherCount | records | INTEGER | 是 | 其他数量 |
lendCount | records | INTEGER | 是 | 接用数量 |
返回结果示例
{
"code": 200,
"data": {
"current": 1,
"pages": 1,
"records": [
{
"badCount": 0,
"categoryId": 1,
"createTime": "2020-09-02 15:12:38",
"creatorId": 2027643,
"loseCount": 0,
"otherCount": 0,
"remainCount": 5,
"remark": "111",
"status": 2,
"stockCount": 5,
"toolId": 2,
"toolImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"toolName": "小锤子",
"toolshedId": 1,
"useImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb"
}
],
"searchCount": true,
"size": 10,
"total": 1
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.2.2: 新增工具
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | BODY | LONG | 是 | 工具房id |
categoryId | BODY | LONG | 是 | 工具类型id |
toolName | BODY | STRING | 是 | 工具名称 |
toolImg | BODY | STRING | 是 | 工具图片 |
useImg | BODY | STRING | 是 | 使用方法图片 |
stockCount | BODY | INTEGER | 是 | 总库存 |
remark | BODY | STRING | 是 | 备注 |
creatorId | BODY | INTEGER | 是 | 创建人id |
请求Body描述(非Form表单数据)
{
"toolshedId":1,
"categoryId":1,
"toolName":"小锤子",
"toolImg":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"useImg":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"stockCount":5,
"remark":"111",
"creatorId":2027643
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.2.3: 工具详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolId | BODY | LONG | 是 | 工具id |
请求Body描述(非Form表单数据)
{
"toolId":2
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
toolId | DATA | LONG | 是 | 工具id |
toolshedId | DATA | LONG | 是 | 工具房id |
categoryId | DATA | LONG | 是 | 工具类型id |
toolName | DATA | STRING | 是 | 工具名称 |
toolImg | DATA | STRING | 否 | 工具图片 |
useImg | DATA | STRING | 否 | 使用方法图片 |
stockCount | DATA | INTEGER | 是 | 总库存 |
remainCount | DATA | INTEGER | 是 | 剩余库存 |
remark | DATA | STRING | 是 | 备注 |
status | DATA | INTEGER | 是 | 状态 1-上架 2-下架 |
createTime | DATA | STRING | 是 | 创建时间 |
creatorId | DATA | INTEGER | 是 | 创建人id |
badCount | DATA | INTEGER | 是 | 损坏数量 |
loseCount | DATA | INTEGER | 是 | 丢失数量 |
otherCount | DATA | INTEGER | 是 | 其他数量 |
返回结果示例
{
"code": 200,
"data": {
"badCount": 0,
"categoryId": 1,
"createTime": "2020-09-02 15:12:38",
"creatorId": 2027643,
"loseCount": 0,
"otherCount": 0,
"remainCount": 5,
"remark": "111",
"status": 2,
"stockCount": 5,
"toolId": 2,
"toolImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"toolName": "小锤子",
"toolshedId": 1,
"useImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb"
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.2.4: 编辑工具信息
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/edit
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolId | DATA | LONG | 是 | 工具id |
categoryId | DATA | LONG | 否 | 工具类型id |
toolName | DATA | STRING | 否 | 工具名称 |
toolImg | DATA | STRING | 否 | 工具图片 |
useImg | DATA | STRING | 否 | 使用方法图片 |
stockCount | DATA | INTEGER | 否 | 总库存 |
remark | DATA | STRING | 否 | 备注 |
badCount | DATA | INTEGER | 否 | 损坏数量 |
loseCount | DATA | INTEGER | 否 | 丢失数量 |
otherCount | DATA | INTEGER | 否 | 其他数量 |
请求Body描述(非Form表单数据)
{
"toolId":1,
"categoryId":1,
"toolName":"小锤子",
"toolImg":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"useImg":"https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"stockCount":5,
"remark":"111",
"badCount":0,
"loseCount":0,
"otherCount":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"修改后库存剩余数量不能小于0","data":{}}
15.2.5: 工具上架/下架
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/edit/status
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolId | DATA | LONG | 是 | 工具id |
status | DATA | INTEGER | 是 | 状态 1-上架 2-下架 |
请求Body描述(非Form表单数据)
{
"toolId":1,
"status":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.2.6: 删除工具
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/delete
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolId | DATA | LONG | 是 | 工具id |
请求Body描述(非Form表单数据)
{
"toolId":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.3.1: 新增工具类型
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/category/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | DATA | LONG | 是 | 工具屋id |
categoryName | DATA | LONG | 是 | 工具类型 |
请求Body描述(非Form表单数据)
{
"categoryName":"锤子类",
"toolshedId":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.3.2: 工具类型列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/category/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | DATA | LONG | 是 | 工具屋id |
请求Body描述(非Form表单数据)
{
"toolshedId":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
categoryId | DATA | LONG | 是 | 工具类型id |
categoryName | DATA | STRING | 是 | 工具类型名称 |
toolshedId | DATA | LONG | 是 | 工具屋id |
返回结果示例
{
"code": 200,
"data": [
{
"categoryId": 1,
"categoryName": "锤子类",
"toolshedId": 1
}
],
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.4.1: 借还记录列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/listRecordByPage
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
pageNo | BODY | INTEGER | 是 | 当前页 |
pageSize | BODY | INTEGER | 是 | 每页记录数 |
toolshedId | BODY | INTEGER | 否 | 工具房ID |
communityId | BODY | INTEGER | 否 | 社区ID |
phone | BODY | STRING | 否 | 电话 |
userName | BODY | STRING | 否 | 用户姓名 |
statusList | BODY | array | 否 | 状态 1借出 2超期 3归还 |
请求Body描述(JSON)
{
"pageNo":1,
"pageSize":10,
"toolshedId":1,
"communityId":21291194,
"phone":"187333733",
"statusList":[1,2]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
borrowTime | DATA | DATE | 是 | 开门确认借出时间 |
communityId | DATA | LONG | 是 | 社区Id |
houseName | DATA | string | 是 | 房号 |
phone | DATA | string | 是 | 电话 |
toolNames | DATA | string | 是 | 工具列表 |
userName | DATA | string | 是 | 用户名称 |
返回结果示例
{
"code": 200,
"data": {
"current": 1,
"orders": [],
"pages": 1,
"records": [
{
"borrowTime": "2020-09-07 09:38:59",
"communityId": 21291194,
"createTime": "2020-09-07 09:55:56",
"editTimes": 1,
"houseId": 35000002,
"houseName": "8栋1单元501",
"phone": "13924818864",
"pushTimes": 0,
"recordId": 6,
"returnTime": null,
"status": 1,
"toolNames": "小锤子",
"toolshedId": 1,
"userId": 295,
"userName": "陈慧丽",
"remark":"备注"
}
],
"searchCount": true,
"size": 10,
"total": 1
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.4.2: 借还详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/getRecordDetail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | INTEGER | 是 | 记录ID |
请求Body描述(JSON)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
borrowList | DATA | array | 是 | 借出列表 |
record | DATA | object | 是 | 记录详情 |
returnList | DATA | array | 是 | 归还列表 |
borrowList.borrowCount | DATA | INTEGER | 是 | 借出数量 |
borrowList.toolName | DATA | INTEGER | 是 | 工具名称 |
borrowList.toolCode | DATA | INTEGER | 是 | 工具编号 |
returnList.returnStatus | DATA | Integer | 是 | 归还状态 1正常 2损坏 3丢失 4其他 |
返回结果示例
{
"code": 200,
"data": {
"borrowList": [
{
"borrowCount": 3,
"borrowId": 16,
"recordId": 6,
"remark": "",
"toolCode": "",
"toolId": 3,
"toolName": "小锤子"
}
],
"record": {
"borrowTime": "2020-09-07 09:38:59",
"communityId": 21291194,
"createTime": "2020-09-07 09:55:56",
"editTimes": 1,
"houseId": 35000002,
"houseName": "8栋1单元501",
"phone": "13924818864",
"pushTimes": 0,
"recordId": 6,
"returnTime": null,
"status": 1,
"toolNames": "",
"toolshedId": 1,
"userId": 295,
"userName": "陈慧丽"
},
"returnList": [
{
"returnId": 16,
"recordId": 6,
"remark": "",
"toolCode": "",
"toolId": 3,
"toolName": "小锤子",
"returnStatus": 1
}
]
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.4.3: 后台归还
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/returnByAdmin
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{"recordId":3}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
data | 顶层 | object | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data":{},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.4.4: 后台未归还
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/returnToBorrow
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{"recordId":3}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
data | 顶层 | object | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data":{},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.5.1: 黑名单新增与修改
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/saveBlacklist
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
blacklistId | BODY | Long | 否 | 黑名单ID (如果Id 为空则新增) |
userId | BODY | Long | 是 | 用户ID |
recordId | BODY | Long | 是 | 纪录ID |
communityId | BODY | Long | 是 | 社区ID |
houseId | BODY | Long | 是 | 房屋ID |
remark | BODY | String | 是 | 描述 |
startTime | BODY | DateTime | 否 | 黑名单开始时间 |
expirationTime | BODY | DateTime | 否 | 黑名单结束时间 |
请求Body描述(JSON)
新增:
{
"blacklistId":"",
"userId":"148",
"recordId":"2",
"communityId":"21322204",
"houseId":"35262256",
"remark":"输入的字数要超过十个",
"startTime":"2020-09-09",
"expirationTime":"2020-09-26"
}
更新延期:
{
"blacklistId": 34,
"startTime": 1599629117000,
"expirationTime": 1602221117000,
"remark": "输入的hethhrethethertherthrthet鞍山市萨法发etetggggggggggggttttttttttttttttttttttttttttttttttt字访问后台日活月活的话哈哈哈哈哈哈哈哈哈哈或或或或或或动态规划 搞屎棍司法改革或或输入的hethhrethethertherthrthet鞍山市萨法发"
}
返回信息
返回参数类型
JSON
返回参数
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{
"code": 300,
"data": {},
"message": "Submit Message Error"
}
15.5.2: 黑名单列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/removeBlacklist
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
blacklistId | BODY | Long | 是 | 黑名单ID (如果Id 为空则新增) |
请求Body描述(JSON)
{
"blacklistId":"86"
}
返回信息
返回参数类型
JSON
返回参数
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{
"code": 300,
"data": {},
"message": "Fail"
}
15.5.3: 黑名单列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/getBlacklist
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | Long | 是 | 社区ID |
search | BODY | String | 是 | 模糊查询内容 |
status | BODY | Integer | 否 | 状态 :0失效 1生效 2移除 |
pageNo | BODY | Integer | 否 | 当前页 |
pageSize | BODY | Integer | 否 | 当前页数 |
请求Body描述(JSON)
{
"communityId":"",
"phone":"",
"userName":"",
"houseName":"",
"status":"",
"pageNo":"",
"pageSize":""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
blacklistId | BODY | Long | 否 | 黑名单ID (如果Id 为空则新增) |
userId | BODY | Long | 是 | 用户ID |
userName | BODY | String | 是 | 黑名单ID |
phone | BODY | String | 是 | 电话号码 |
recordId | BODY | Long | 是 | 纪录ID |
communityId | BODY | Long | 是 | 社区ID |
communityName | BODY | String | 是 | 社区名 |
houseId | BODY | Long | 是 | 房屋ID |
houseName | BODY | String | 是 | 房屋名称 |
limitTerm | BODY | Integer | 是 | 黑名单期限(月) |
remark | BODY | String | 是 | 描述 |
status | BODY | Integer | 是 | 状态 :0失效 1生效 2移除 |
start_time | BODY | DateTime | 是 | 黑名单开始时间 |
expirationTime | BODY | DateTime | 是 | 黑名单结束时间 |
creator | BODY | String | 是 | 创建人 |
createTime | BODY | DateTime | 是 | 生成时间 |
operator | BODY | String | 是 | 操作人 |
operate_time | BODY | DateTime | 是 | 最近操作时间 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{
"code": 200,
"data": {
"current": 1,
"orders": [],
"pages": 1,
"records": [
{
"blacklistId": 34,
"communityId": 1003837,
"communityName": "美的翰诚嘉园",
"createTime": 1599629117000,
"creator": "邓仕英",
"expirationTime": 1599494400000,
"houseId": 928606,
"houseName": "2栋_1单元_1203",
"limitPeriod": "",
"operateTime": 1599630695000,
"operator": "杨观超",
"phone": "15975755607",
"recordId": 1,
"remark": "狗狗的hethhrethethertherthrthet鞍山市萨法发etetggggggggggggttttttttttttttttttttttttttttttttttt字访问后台日活月活的话哈哈哈哈哈哈哈哈哈哈或或或或或",
"startTime": 1598889600000,
"status": 0,
"userId": 805,
"userName": "刘顺利"
},
{
"blacklistId": 35,
"communityId": 21322204,
"communityName": "邯郸美的城",
"createTime": 1599632325000,
"creator": "杨观超",
"expirationTime": 1602224325000,
"houseId": 35262256,
"houseName": "5栋1单元1003",
"limitPeriod": "",
"operateTime": 1599632325000,
"operator": "杨观超",
"phone": "18038758060",
"recordId": 2,
"remark": "输入的字数要超过十个",
"startTime": 1599632325000,
"status": 1,
"userId": 148,
"userName": "赵楚碧"
}
],
"searchCount": true,
"size": 3,
"total": 2
},
"message": "success"
}
15.11.1: app工具列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/app/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
toolshedId | BODY | LONG | 是 | 工具屋Id |
请求Body描述(非Form表单数据)
{
"toolshedId":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
current | DATA | INTEGER | 是 | 当前页数 |
total | DATA | INTEGER | 是 | 数据条数 |
pages | DATA | INTEGER | 是 | 总页数 |
size | DATA | INTEGER | 是 | 每页数量 |
toolId | records | LONG | 是 | 工具id |
categoryName | records | STRING | 是 | 工具类型名称 |
toolName | records | STRING | 是 | 工具名称 |
toolImg | records | STRING | 是 | 工具图片 |
useImg | records | STRING | 是 | 使用方法图片 |
remainCount | records | INTEGER | 是 | 剩余库存 |
返回结果示例
{
"code": 200,
"data": {
"current": 1,
"orders": [],
"pages": 1,
"records": [
{
"categoryName": "锤子类",
"remainCount": 5,
"toolId": 3,
"toolImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb",
"toolName": "小锤子",
"useImg": "https://iot-xlink.oss-cn-hangzhou.aliyuncs.com/df632cbe4a263e44d7ef290ddeb9c8eb"
}
],
"searchCount": true,
"size": 10,
"total": 1
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.1: 用户借还初始状态
描述
APP进入该功能页面时,通过该状态跳转到相应的页面
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/getInitStatus
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
status | DATA | INTEGER | 是 | 0正常-跳转到工具列表 1借了并在确认范围内-跳转确认界面 2有工具未还-跳转归还界面 3黑名单-不给进入 |
返回结果示例
{
"code": 200,
"data": {
"status":0
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.2: 用户当前的借出记录
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/getCurrentRecord
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
status | DATA | INTEGER | 是 | 0暂存 1借出 2超期 3归还 |
borrowTime | DATA | date | 是 | 借出时间 |
returnTime | DATA | date | 是 | 归还时间 |
identifyCountTime | DATA | object | 是 | 确认时间倒数 |
borrowDuration | DATA | object | 是 | 借用时时长 |
返回结果示例
{
"code": 200,
"data": {
"blacklistStatus": 0,
"borrowDuration": {
"hour": 0,
"day": 0,
"minute": 0
},
"borrowTime": null,
"communityId": 1003837,
"communityName": "美的翰诚嘉园",
"createTime": "2020-09-12 14:08:32",
"editTimes": 0,
"houseId": 1225183,
"houseName": "11栋_1单元_2703",
"identifyCountTime": {
"countMinute": 0,
"countSecond": 0
},
"phone": "18924558942",
"pushTimes": 0,
"recordId": 9,
"remark": "",
"returnTime": null,
"status": 0,
"toolNames": "",
"toolshedId": 1,
"userId": 308,
"userName": "罗金柳生",
"borrowList":[{
"borrowCount": 3,
"borrowId": 16,
"recordId": 6,
"remark": "",
"toolCode": "",
"toolId": 3,
"toolName": "小锤子"
}]
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.3: 保存借出列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/saveBorrowList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID,如果该ID为空则需要传入communityId,houseId,phone,toolshedId表示该记录为新的记录。 |
communityId | BODY | LONG | 是 | 社区ID |
houseId | BODY | LONG | 是 | 房间ID |
toolshedId | BODY | long | 是 | 工具屋ID |
borrowList | BODY | array | 是 | 借出列表 |
borrowList.toolId | BODY | long | 是 | 工具ID |
borrowList.borrowCount | BODY | INTEGER | 是 | 借出数量 |
请求Body描述(非Form表单数据)
{
"communityId":21291194,
"houseId":35000002,
"toolshedId":1,
"recordId":"",
"borrowList":[
{"toolId":3,"borrowCount":2}
]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
recordId | DATA | INTEGER | 是 | 记录ID |
返回结果示例
{
"code": 200,
"data": {
"recordId":6
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.4: 借出开门成功后调用
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/borrowOpenDoor
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.5: 保存确认借出清单
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/identifyBorrowList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
borrowList | BODY | array | 是 | 借出列表 |
borrowList.toolId | BODY | Integer | 是 | 借出工具ID |
borrowList.borrowCount | BODY | Integer | 是 | 借出数量 |
请求Body描述(非Form表单数据)
{
"recordId":6,
"borrowList":[
{"toolId":3,"borrowCount":3}
]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.6: 当前借出列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/listCurrentBorrow
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
data | 顶层 | object | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": [
{
"borrowCount": 3,
"borrowId": 16,
"recordId": 6,
"remark": "",
"toolCode": "",
"toolId": 3,
"toolName": "小锤子"
}
],
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.7: 当前归还列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/listCurrentReturn
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
data | 顶层 | object | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": [
{
"recordId": 6,
"remark": "",
"returnId": 0,
"returnStatus": 0,
"toolCode": "",
"toolId": 0,
"toolName": "小锤子"
},
{
"recordId": 6,
"remark": "",
"returnId": 0,
"returnStatus": 0,
"toolCode": "",
"toolId": 0,
"toolName": "小锤子"
},
{
"recordId": 6,
"remark": "",
"returnId": 0,
"returnStatus": 0,
"toolCode": "",
"toolId": 0,
"toolName": "小锤子"
}
],
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.8: 归还开门成功后调用
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/returnOpenDoor
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
returnList | BODY | array | 是 | 归还列表 |
returnList.toolId | BODY | INTEGER | 是 | 工具ID |
returnList.recordId | BODY | LONG | 是 | 记录ID |
returnList.returnStatus | BODY | integer | 是 | 归还状态 1正常 2损坏 3丢失 4其他 |
请求Body描述(非Form表单数据)
{"recordId":3,
"returnList":[{"toolId":3,"recordId":3,"returnStatus":1,"remark":"正常"},
{"toolId":3,"recordId":3,"returnStatus":2,"remark":"损坏"}]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
data | 顶层 | object | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data":{},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.9: 借出开门前验证
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/checkBorrowOpenDoor
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}
15.12.10: 归还开门前验证
描述
返回 code =20002时,跳转到借用初始页
请求信息
HTTP协议:HTTP,HTTPS
uri:/biz/running/center/share/tool/record/checkReturnOpenDoor
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
recordId | BODY | long | 是 | 记录ID |
请求Body描述(非Form表单数据)
{
"recordId":6
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码 |
message | 顶层 | STRING | 是 | 响应信息 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
异常返回示例
{"code":500,"message":"网络异常","data":{}}