You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
286 lines
6.3 KiB
286 lines
6.3 KiB
3 years ago
|
## 公共参数说明
|
||
|
|
### 列表分页参数
|
||
|
|
|参数名|参数类型|必填|参数说明|
|
||
|
|
|-----|-----|-----|-----|
|
||
|
|
|current|int|是|当前页|
|
||
|
|
|size|int|是|每页的数量|
|
||
|
|
|
||
|
|
## 1 公共接口
|
||
|
|
### 1.1 医院列表
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-system/dept-hospital/list-hospital`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
无
|
||
|
|
|
||
|
|
|
||
|
|
### 1.2 医院文章列表
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/page`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|title|String|标题|
|
||
|
|
|
||
|
|
### 1.3 添加医院文章
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/save`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|title|String|标题|
|
||
|
|
|content|String|内容|
|
||
|
|
|
||
|
|
### 1.4 根据ID获取文章详细
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/detail-by-id`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|id|Long|医院Id|
|
||
|
|
|
||
|
|
### 1.5 根据医院ID获取文章详细
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/detail-publish`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|
||
|
|
### 1.7 发布/取消发布文章
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/publish`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|id|Long|要操作的文章ID|
|
||
|
|
|publishFlag|String|发布标注, '0':取消发布, '1':发布|
|
||
|
|
|
||
|
|
### 1.8 删除文章
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/article/remove`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|ids|String|文章Id, 多篇文章id以`,`分割|
|
||
|
|
|
||
|
|
## 2 放号
|
||
|
|
### 2.1 已放号天列表
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/apm-config/already-config-day`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|
||
|
|
### 2.2 保存放号记录
|
||
|
|
##### URL
|
||
|
|
`POST` `blade-business/apm-config/save`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|configListVOS|List|保存对象|
|
||
|
|
|- createDept|Long|医院Id|
|
||
|
|
|- project|String|项目|
|
||
|
|
|- cuAddr|String|体检地址|
|
||
|
|
|- apmDay|String|放号天, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|- detailList|List|放号详细|
|
||
|
|
|- - period|String|时段(上午,下午)|
|
||
|
|
|- - timeFrame|String|时间范围, 例:9:00-9:30|
|
||
|
|
|- - numberNum|int|放号数量|
|
||
|
|
|
||
|
|
```示例
|
||
|
|
[
|
||
|
|
{
|
||
|
|
createDept: 10215,
|
||
|
|
project: '视力',
|
||
|
|
cuAddr: '三楼眼科',
|
||
|
|
apmDay: '2023-03-12',
|
||
|
|
detailList: [
|
||
|
|
{
|
||
|
|
period:'上午',
|
||
|
|
timeFrame: '9:00-9:30',
|
||
|
|
numberNum: 5
|
||
|
|
},
|
||
|
|
{
|
||
|
|
period:'上午',
|
||
|
|
timeFrame: '9:30-10:00',
|
||
|
|
numberNum: 5
|
||
|
|
},
|
||
|
|
...
|
||
|
|
]
|
||
|
|
}
|
||
|
|
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2.3 获取放号记录详细
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/apm-config/detail`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|project|String|项目|
|
||
|
|
|cuAddr|String|体检地址|
|
||
|
|
|apmDay|String|放号天, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|detailList|List|放号详细|
|
||
|
|
|- period|String|时段(上午,下午)|
|
||
|
|
|- timeFrame|String|时间范围, 例:9:00-9:30|
|
||
|
|
|- numberNum|int|放号数量|
|
||
|
|
|- apmNum|int|已预约数量|
|
||
|
|
|
||
|
|
```示例
|
||
|
|
[
|
||
|
|
{
|
||
|
|
createDept: 10215,
|
||
|
|
project: '视力',
|
||
|
|
cuAddr: '三楼眼科',
|
||
|
|
apmDay: '2023-03-12',
|
||
|
|
detailList: [
|
||
|
|
{
|
||
|
|
period:'上午',
|
||
|
|
timeFrame: '9:00-9:30',
|
||
|
|
numberNum: 5,
|
||
|
|
apmNum: 0
|
||
|
|
},
|
||
|
|
{
|
||
|
|
period:'上午',
|
||
|
|
timeFrame: '9:30-10:00',
|
||
|
|
numberNum: 5,
|
||
|
|
apmNum: 0
|
||
|
|
},
|
||
|
|
...
|
||
|
|
]
|
||
|
|
}
|
||
|
|
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2.4 放号记录列表
|
||
|
|
##### URL
|
||
|
|
`GET` `blade-business/apm-config/page`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|createDept|Long|医院Id|
|
||
|
|
|project|String|项目|
|
||
|
|
|apmDay|String|放号天, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
##### 返回示例
|
||
|
|
```
|
||
|
|
[
|
||
|
|
{
|
||
|
|
医院: 海慈
|
||
|
|
项目 : 视力
|
||
|
|
地址 : 三楼眼科
|
||
|
|
放号天: 2023-1-1
|
||
|
|
时间: [
|
||
|
|
{
|
||
|
|
时段: 上午
|
||
|
|
时段范围: 9:00-10:00
|
||
|
|
放号数量: 5
|
||
|
|
已预约数量: 2
|
||
|
|
},
|
||
|
|
{
|
||
|
|
时段: 上午
|
||
|
|
时段范围: 9:00-10:00
|
||
|
|
放号数量: 5
|
||
|
|
已预约数量: 2
|
||
|
|
},
|
||
|
|
...
|
||
|
|
]
|
||
|
|
},
|
||
|
|
...
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
## 3 预约及报到
|
||
|
|
### 3.1 检查用户是否可预约-医院
|
||
|
|
##### 说明
|
||
|
|
加载体检医院前, 调用接口判断用户是否今天已有预约, 若已有预约, 返回医院列表, 若已加入黑名单, 拒绝预约
|
||
|
|
|
||
|
|
### 3.2 获取医院所有放号的列表
|
||
|
|
##### 说明
|
||
|
|
根据时间(天)获取医院的放号列表, 返回结果需携带是否可预约的标记
|
||
|
|
// 加载体检预约项目前, 调用接口判断用户当天是否已有此类项目预约, 若已有, 返回已预约的项目列表, 若已加入黑名单, 拒绝预约
|
||
|
|
##### 返回示例
|
||
|
|
```
|
||
|
|
[
|
||
|
|
{
|
||
|
|
project : 视力
|
||
|
|
地址 : 三楼眼科
|
||
|
|
剩余号数: 19/20
|
||
|
|
时间: [
|
||
|
|
{
|
||
|
|
时段: 上午
|
||
|
|
时段范围: 9:00-10:00
|
||
|
|
余号: 5
|
||
|
|
是否可预约: 0/1
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
...
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
### 3.4 保存预约记录
|
||
|
|
|
||
|
|
### 3.5 取消预约记录
|
||
|
|
|
||
|
|
### 3.6 更新预约记录状态
|
||
|
|
##### 说明
|
||
|
|
用户报到后, 调用接口, 更新预约记录为`已报到`
|
||
|
|
|
||
|
|
## 5 黑名单
|
||
|
|
### 5.1 列表
|
||
|
|
##### URL
|
||
|
|
`GET`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|参数说明|
|
||
|
|
|-----|-----|-----|
|
||
|
|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss|
|
||
|
|
|cupCardNo|String|体检人证件号|
|
||
|
|
|
||
|
|
##### 返回数据
|
||
|
|
|
||
|
|
### 5.2 根据用户证件号获取详细
|
||
|
|
##### URL
|
||
|
|
`POST`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|必填|参数说明|
|
||
|
|
|-----|-----|-----|-----|
|
||
|
|
|cardNo|String|是|用户证件号|
|
||
|
|
|
||
|
|
##### 返回数据
|
||
|
|
|
||
|
|
### 5.3 删除
|
||
|
|
##### URL
|
||
|
|
`POST`
|
||
|
|
|
||
|
|
##### 请求参数
|
||
|
|
|参数名|参数类型|必填|参数说明|
|
||
|
|
|-----|-----|-----|-----|
|
||
|
|
|id|int|是|记录Id|
|
||
|
|
|
||
|
|
##### 返回数据
|
||
|
|
|
||
|
|
### 5.4
|