suojin
/
physical_examination_back
14
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

接口文档更新

Browse Source
master
liuqingkun 3 years ago
parent 756acb7ec1
commit 4f0a6caafc
1 changed files with 42 additions and 17 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 59
      api_doc.md

59
api_doc.md
Unescape View File

@ -41,8 +41,8 @@
|参数名|参数类型|参数说明| |参数名|参数类型|参数说明|
|-----|-----|-----| |-----|-----|-----|
|createDept|Long|医院Id| |createDept|Long|医院Id|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss| |startTime|String|查询开始时间, 格式yyyy-MM-dd|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss| |endTime|String|查询结束时间, 格式yyyy-MM-dd|
|title|String|标题| |title|String|标题|
### 1.3 添加医院文章 ### 1.3 添加医院文章
@ -102,8 +102,8 @@
|参数名|参数类型|参数说明| |参数名|参数类型|参数说明|
|-----|-----|-----| |-----|-----|-----|
|createDept|Long|医院Id| |createDept|Long|医院Id|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss| |startTime|String|查询开始时间, 格式yyyy-MM-dd|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss| |endTime|String|查询结束时间, 格式yyyy-MM-dd|
### 2.2 保存放号记录 ### 2.2 保存放号记录
##### URL ##### URL
@ -112,11 +112,12 @@
##### 请求参数 ##### 请求参数
|参数名|参数类型|参数说明| |参数名|参数类型|参数说明|
|-----|-----|-----| |-----|-----|-----|
|createDept|Long|医院Id|
|dayList|List<String>|放号天列表, 时间格式yyyy-MM-dd|
|configListVOS|List|保存对象| |configListVOS|List|保存对象|
|- createDept|Long|医院Id| |- createDept|Long|医院Id|
|- project|String|项目| |- project|String|项目|
|- cuAddr|String|体检地址| |- cuAddr|String|体检地址|
|- apmDay|String|放号天, 格式yyyy-MM-dd HH:mm:ss|
|- detailList|List|放号详细| |- detailList|List|放号详细|
|- - period|String|时段(上午,下午)| |- - period|String|时段(上午,下午)|
|- - timeFrame|String|时间范围, 例:9:00-9:30| |- - timeFrame|String|时间范围, 例:9:00-9:30|
@ -154,7 +155,7 @@
|-----|-----|-----| |-----|-----|-----|
|createDept|Long|医院Id| |createDept|Long|医院Id|
|project|String|项目| |project|String|项目|
|apmDay|String|放号天, 格式yyyy-MM-dd HH:mm:ss| |apmDay|String|放号天, 格式yyyy-MM-dd|
```json ```json
[ [
@ -188,8 +189,8 @@
|-----|-----|-----| |-----|-----|-----|
|createDept|Long|医院Id| |createDept|Long|医院Id|
|project|String|项目| |project|String|项目|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss| |startTime|String|查询开始时间, 格式yyyy-MM-dd|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss| |endTime|String|查询结束时间, 格式yyyy-MM-dd|
##### 返回示例 ##### 返回示例
``` ```
@ -227,6 +228,17 @@
##### 说明 ##### 说明
根据时间(天)获取医院的放号列表, 返回结果需携带是否可预约的标记 根据时间(天)获取医院的放号列表, 返回结果需携带是否可预约的标记
// 加载体检预约项目前, 调用接口判断用户当天是否已有此类项目预约, 若已有, 返回已预约的项目列表, 若已加入黑名单, 拒绝预约 // 加载体检预约项目前, 调用接口判断用户当天是否已有此类项目预约, 若已有, 返回已预约的项目列表, 若已加入黑名单, 拒绝预约
##### URL
`POST` `blade-business/apm-config/detail-for-apm`
##### 请求数据
|参数名|参数类型|参数说明|
|-----|-----|-----|
|createDept|Long|医院Id|
|apmDay|String|放号天, 格式yyyy-MM-dd|
|cupCardNo|String|体检人证件号|
##### 返回示例 ##### 返回示例
``` ```
[ [
@ -259,6 +271,19 @@
] ]
``` ```
### 3.3 预约记录列表
##### URL
`GET` `blade-business/apm-record/page`
##### 请求参数
|参数名|参数类型|参数说明|
|-----|-----|-----|
|createDept|Long|医院Id|
|startTime|String|查询开始时间, 格式yyyy-MM-dd|
|endTime|String|查询结束时间, 格式yyyy-MM-dd|
|cupCardNo|String|体检人证件号|
### 3.4 保存预约记录 ### 3.4 保存预约记录
##### URL ##### URL
`POST` `blade-business/apm-record/save` `POST` `blade-business/apm-record/save`
@ -307,21 +332,21 @@
|-----|-----|-----| |-----|-----|-----|
|id|Long|预约记录ID| |id|Long|预约记录ID|
## 5 黑名单 ## 4 黑名单
### 5.1 列表 ### 4.1 列表
##### URL ##### URL
`GET` `blade-business/blacklist/page` `GET` `blade-business/blacklist/page`
##### 请求参数 ##### 请求参数
|参数名|参数类型|参数说明| |参数名|参数类型|参数说明|
|-----|-----|-----| |-----|-----|-----|
|startTime|String|查询开始时间, 格式yyyy-MM-dd HH:mm:ss| |startTime|String|查询开始时间, 格式yyyy-MM-dd|
|endTime|String|查询结束时间, 格式yyyy-MM-dd HH:mm:ss| |endTime|String|查询结束时间, 格式yyyy-MM-dd|
|cupCardNo|String|体检人证件号| |cupCardNo|String|体检人证件号|
##### 返回数据 ##### 返回数据
### 5.2 根据用户证件号获取详细 ### 4.2 根据用户证件号获取详细
##### URL ##### URL
`POST` `blade-business/blacklist/detail-by-cardno` `POST` `blade-business/blacklist/detail-by-cardno`
@ -332,7 +357,7 @@
##### 返回数据 ##### 返回数据
### 5.3 删除 ### 4.3 删除
##### URL ##### URL
`POST` `blade-business/blacklist/remove` `POST` `blade-business/blacklist/remove`
@ -343,16 +368,16 @@
##### 返回数据 ##### 返回数据
### 5.4 获取正在生效的黑名单 ### 4.4 获取正在生效的黑名单
##### 说明 ##### 说明
根据用户证件号获取正在生效的黑名单, 若无正在生效的黑名单, 返回空 根据用户证件号获取正在生效的黑名单, 若无正在生效的黑名单, 返回空
##### URL ##### URL
`POST` `blade-business/blacklist/user-blacklist` `GET` `blade-business/blacklist/user-blacklist`
##### 请求参数 ##### 请求参数
|参数名|参数类型|必填|参数说明| |参数名|参数类型|必填|参数说明|
|-----|-----|-----|-----| |-----|-----|-----|-----|
|cupCardNo|String|体检人证件号| |cupCardNo|String|是|体检人证件号|
##### 返回数据 ##### 返回数据

Write Preview
Loading…
Cancel
Save