接口文档更新

3 years ago · a992eb97f9
parent c21fc87328
commit a992eb97f9
1 changed files with 234 additions and 41 deletions
--- a/api_doc.md
+++ b/api_doc.md
@ -34,8 +34,6 @@
 |查看我的预约|blade-business/apm-record/page|
 |取消预约|blade-business/apm-record/cancel|

-
-
 ## 1 公共接口
 ### 1.1 医院列表
 ##### URL
@ -69,12 +67,49 @@
 `GET` `blade-business/article/page`

 ##### 请求参数
-|参数名|参数类型|参数说明|
-|-----|-----|-----|
-|createDept|Long|医院Id|
-|startTime|String|查询开始时间, 格式yyyy-MM-dd|
-|endTime|String|查询结束时间, 格式yyyy-MM-dd|
-|title|String|标题|
+|参数名|参数类型|必填|参数说明|
+|-----|-----|-----|-----|
+|createDept|Long|是|医院Id|
+|startTime|String|否|查询开始时间, 格式yyyy-MM-dd|
+|endTime|String|否|查询结束时间, 格式yyyy-MM-dd|
+|title|String|否|标题, 模糊查询|
+
+```json
+{
+    "code": 200,
+    "success": true,
+    "data": {
+        "records": [
+            {
+                "id": "1625033089659109377",
+                "createDept": "1623571646250143746",
+                "title": "青岛市海慈医院体检预约须知",
+                "content": "青岛市海慈医院体检预约须知",
+                "publishTime": "2023-02-13 15:35:03",
+                "publishSta": "2"
+            },
+            {
+                "id": "1625035879760461825",
+                "createDept": "1623571646250143746",
+                "title": "124",
+                "content": "1335",
+                "publishTime": "",
+                "publishSta": "2"
+            }
+        ],
+        "total": 3,
+        "size": 10,
+        "current": 1,
+        "orders": [],
+        "optimizeCountSql": true,
+        "searchCount": true,
+        "countId": "",
+        "maxLimit": -1,
+        "pages": 1
+    },
+    "msg": "操作成功"
+}
+```

 ### 1.3 添加医院文章
 ##### URL
@ -87,14 +122,41 @@
 |title|String|标题|
 |content|String|内容|

+##### 请求示例
+注: content提交前进行html转码, 否则系统会自动进行转码
+```json
+{
+	"title": "12243",
+	"content": "<p>dfdfd</p>",
+	"createDept": "1623571646250143746"
+}
+```
+
 ### 1.4 根据ID获取文章详细
 ##### URL
 `GET` `blade-business/article/detail-by-id`

 ##### 请求参数
-|参数名|参数类型|参数说明|
-|-----|-----|-----|
-|id|Long|医院Id|
+|参数名|参数类型|必填|参数说明|
+|-----|-----|-----|-----|
+|id|Long|是|医院Id|
+
+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {
+		"id": "1625033089659109377",
+		"createDept": "1623571646250143746",
+		"title": "青岛市海慈医院体检预约须知",
+		"content": "青岛市海慈医院体检预约须知",
+		"publishTime": "2023-02-13 15:35:03",
+		"publishSta": "2"
+	},
+	"msg": "操作成功"
+}
+```

 ### 1.5 根据医院ID获取文章详细
 ##### URL
@ -105,6 +167,16 @@
 |-----|-----|-----|
 |createDept|Long|医院Id|

+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
+
 ### 1.7 发布/取消发布文章
 ##### URL
 `GET` `blade-business/article/publish`
@ -115,6 +187,16 @@
 |id|Long|要操作的文章ID|
 |publishFlag|String|发布标注, '0':取消发布, '1':发布|

+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
+
 ### 1.8 删除文章
 ##### URL
 `GET` `blade-business/article/remove`
@ -122,7 +204,17 @@
 ##### 请求参数
 |参数名|参数类型|参数说明|
 |-----|-----|-----|
-|ids|String|文章Id, 多篇文章id以`,`分割|
+|ids|String|要删除文章ID, 多个id以`,`分割|
+
+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```

 ## 2 放号
 ### 2.1 已放号天列表
@ -155,26 +247,30 @@
 |- - numberNum|int|放号数量|

 ```json
-[
-    {
-        "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
-            }
-        ]
-    }
-]
+{
+	"createDept": 102,
+	"dayList": [
+		"2023-03-12",
+		"2023-03-14"
+	],
+	"configListVOS": [{
+		"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 获取放号记录详细
@ -258,7 +354,6 @@
 ### 3.2 获取医院所有放号的列表
 ##### 说明
 根据时间(天)获取医院的放号列表, 返回结果需携带是否可预约的标记
-// 加载体检预约项目前, 调用接口判断用户当天是否已有此类项目预约, 若已有, 返回已预约的项目列表, 若已加入黑名单, 拒绝预约

 ##### URL
 `POST` `blade-business/apm-config/detail-for-apm`
@ -314,6 +409,41 @@
 |endTime|String|查询结束时间, 格式yyyy-MM-dd|
 |cupCardNo|String|体检人证件号|

+##### 返回示例
+```json
+{
+    "code": 200,
+    "success": true,
+    "data": {
+        "records": [
+            {
+                "id": "1625048150641430529",
+                "createDept": 1,
+                "project": "单眼视力",
+                "cuAddr": "门诊楼3楼眼科门诊",
+                "period": "上午",
+                "apmDay": "2023-02-13 00:00:00",
+                "timeFrame": "8:00-8:30",
+                "cupName": "靳娜",
+                "cupCardNo": "37092120000618034X",
+                "cupPhone": "17852327323",
+                "apmTime": "2023-02-13 16:24:06",
+                "apmStatus": 0
+            }
+        ],
+        "total": 1,
+        "size": 10,
+        "current": 1,
+        "orders": [],
+        "optimizeCountSql": true,
+        "searchCount": true,
+        "countId": "",
+        "maxLimit": -1,
+        "pages": 1
+    },
+    "msg": "操作成功"
+}
+```

 ### 3.4 保存预约记录
 ##### URL
@ -343,7 +473,7 @@
 		"period": "上午",
 		"timeFrame": "8:00-8:30",
 		"cupName": "张三",
-		"cupPhone": "17852327323",
+		"cupPhone": "17852326379",
 		"cupCardNo": "37092120000618034X"
 	},
 	{
@ -354,7 +484,7 @@
 		"period": "上午",
 		"timeFrame": "8:00-8:30",
 		"cupName": "张三",
-		"cupPhone": "17852327323",
+		"cupPhone": "17852326379",
 		"cupCardNo": "37092120000618034X"
 	}
 ]
@ -362,12 +492,12 @@

 ##### 返回参数
 ###### 失败时msg参数说明
-|参数名|参数说明|
+|信息|说明|
 |-----|-----|
-|"预约失败, 一次只能预约同一个人"|医院Id|
-|"预约失败, 一次只能预约同一天的体检项目"|体检项目|
-|"预约失败, 本日已有其他医院的预约"|体检项目|
-|"预约失败, 本日已有此项目的预约"|体检项目|
+|"预约失败, 一次只能预约同一个人"|同一次保存请求, 参数中`cupName`不同|
+|"预约失败, 一次只能预约同一天的体检项目"|同一次保存请求, 参数中`apmDay`不同|
+|"预约失败, 本日已有其他医院的预约"|每天只能预约1个医院进行体检|
+|"预约失败, 本日已有此项目的预约"|每天只能预约同项目1次|

 ##### 返回示例
 ###### 失败示例
@ -392,13 +522,23 @@

 ### 3.5 取消预约记录
 ##### URL
-`GET` `blade-business/apm-record/cancel`
+`POST` `blade-business/apm-record/cancel`

 ##### 请求参数
 |参数名|参数类型|参数说明|
 |-----|-----|-----|
 |id|Long|预约记录ID|

+##### 返回数据
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
+
 ### 3.6 更新预约记录状态
 ##### 说明
 用户报到后, 调用接口, 更新预约记录为`已报到`
@ -411,6 +551,16 @@
 |-----|-----|-----|
 |id|Long|预约记录ID|

+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```
+
 ### 3.7 根据ID获取详细
 ##### URL
 `GET` `blade-business/apm-record/detail-by-id`
@ -420,6 +570,29 @@
 |-----|-----|-----|
 |id|Long|预约记录ID|

+##### 返回示例
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {
+		"id": "1625057233276706818",
+		"createDept": "1623571646250143746",
+		"project": "单眼视力",
+		"cuAddr": "门诊楼3楼眼科门诊",
+		"period": "上午",
+		"apmDay": "2023-02-13 00:00:00",
+		"timeFrame": "8:00-8:30",
+		"cupName": "张群",
+		"cupCardNo": "371322199005057920",
+		"cupPhone": "15589892890",
+		"apmTime": "2023-02-13 17:00:11",
+		"apmStatus": 0
+	},
+	"msg": "操作成功"
+}
+```
+
 ## 4 黑名单
 ### 4.1 列表
 ##### URL
@ -455,6 +628,14 @@
 |ids|String|是|记录Id|

 ##### 返回数据
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": {},
+	"msg": "操作成功"
+}
+```

 ### 4.4 获取正在生效的黑名单
 ##### 说明
@ -469,3 +650,15 @@
 |cupCardNo|String|是|体检人证件号|

 ##### 返回数据
+|参数名|参数类型|参数说明|
+|-----|-----|-----|
+|data|String|若用户未被拉黑, 返回空字符串, 否则返回错误提示|
+
+```json
+{
+	"code": 200,
+	"success": true,
+	"data": "",
+	"msg": "操作成功"
+}
+```