Przeglądaj źródła

更新 '3-开发设计文档/3-5-服务监督模块/1121-服务监督模块-大屏展示-接口设计.md'

lyw 2 miesięcy temu
rodzic
commit
a02936dc06

+ 100 - 90
3-开发设计文档/3-5-服务监督模块/1121-服务监督模块-大屏展示-接口设计.md

@@ -30,28 +30,28 @@
 
 - 请求参数:
 
-    | 参数名   | 含义       | 类型   | 是否必填 | 备注    |
-    | -------- | ---------- | ------ | -------- | ------- |
-    | dictType | 字典类型   | 字符串 | 必填     |         |
-    | pageNum  | 第几页     | int    |          | 默认1   |
-    | pageSize | 一页记录数 | int    |          | 默认 ? |
+  | 参数名   | 含义       | 类型   | 是否必填 | 备注    |
+  | -------- | ---------- | ------ | -------- | ------- |
+  | dictType | 字典类型   | 字符串 | 必填     |         |
+  | pageNum  | 第几页     | int    |          | 默认1   |
+  | pageSize | 一页记录数 | int    |          | 默认 ? |
 
 - 返回结果:
 
-    | 中文名        | 字段名 | 类型   | 备注                |
-    | ------------- | ------ | ------ | ------------------- |
-    | 状态码        | code   | int    | 200:成功,其他:错误 |
-    | 成功/错误消息 | msg    | string |                     |
-    | 总记录数      | total  | int    |                     |
-    | 结果集        | rows   | 数组   |                     |
+  | 中文名        | 字段名 | 类型   | 备注                |
+  | ------------- | ------ | ------ | ------------------- |
+  | 状态码        | code   | int    | 200:成功,其他:错误 |
+  | 成功/错误消息 | msg    | string |                     |
+  | 总记录数      | total  | int    |                     |
+  | 结果集        | rows   | 数组   |                     |
 
-    - rows 结果集
+  - rows 结果集
 
-        | 字段名    | 含义   | 类型   | 备注 |
-        | --------- | ------ | ------ | ---- |
-        | dictValue | 代码值 | 字符串 |      |
-        | dictLabel | 标题   | 字符串 |      |
-        | dictSort  | 排序   | int    |      |
+    | 字段名    | 含义   | 类型   | 备注 |
+    | --------- | ------ | ------ | ---- |
+    | dictValue | 代码值 | 字符串 |      |
+    | dictLabel | 标题   | 字符串 |      |
+    | dictSort  | 排序   | int    |      |
 
 
 
@@ -63,31 +63,31 @@
 
 - 请求参数:
 
-    | 参数名        | 含义       | 类型   | 是否必填 | 备注                      |
-    | ------------- | ---------- | ------ | -------- | ------------------------- |
-    | pageNum       | 第几页     | int    | 否       |                           |
-    | pageSize      | 一页几条   | int    | 否       |                           |
-    | orderByColumn | 排序字段名 | String |          |                           |
-    | isAsc         | 是否升序   | String |          | descending 降序,默认升序 |
+  | 参数名        | 含义       | 类型   | 是否必填 | 备注                      |
+  | ------------- | ---------- | ------ | -------- | ------------------------- |
+  | pageNum       | 第几页     | int    | 否       |                           |
+  | pageSize      | 一页几条   | int    | 否       |                           |
+  | orderByColumn | 排序字段名 | String |          |                           |
+  | isAsc         | 是否升序   | String |          | descending 降序,默认升序 |
 
 - 返回结果:
 
-    | 中文名        | 字段名 | 类型   | 备注                |
-    | ------------- | ------ | ------ | ------------------- |
-    | 状态码        | code   | int    | 200:成功,其他:错误 |
-    | 成功/错误消息 | msg    | string |                     |
-    | 总记录数      | total  | int    |                     |
-    | 结果集        | rows   | 数组   |                     |
+  | 中文名        | 字段名 | 类型   | 备注                |
+  | ------------- | ------ | ------ | ------------------- |
+  | 状态码        | code   | int    | 200:成功,其他:错误 |
+  | 成功/错误消息 | msg    | string |                     |
+  | 总记录数      | total  | int    |                     |
+  | 结果集        | rows   | 数组   |                     |
 
-    - rows 结果集
+  - rows 结果集
 
-        | 字段名       | 含义     | 类型   | 备注             |
-        | ------------ | -------- | ------ | ---------------- |
-        | id           | id       | Long   |                  |
-        | sourceName   | 来源名称 | 字符串 |                  |
-        | sourceRemark | 备注     | 字符串 |                  |
-        | delFlag      | 删除标记 | 字符串 | 0:没删,1:已删 |
-        | createTime   | 创建时间 |        |                  |
+    | 字段名       | 含义     | 类型   | 备注             |
+    | ------------ | -------- | ------ | ---------------- |
+    | id           | id       | Long   |                  |
+    | sourceName   | 来源名称 | 字符串 |                  |
+    | sourceRemark | 备注     | 字符串 |                  |
+    | delFlag      | 删除标记 | 字符串 | 0:没删,1:已删 |
+    | createTime   | 创建时间 |        |                  |
 
 #### (3)诉求类型列表(ok)
 
@@ -113,29 +113,29 @@
 
 - 请求参数:
 
-    | 参数名        | 含义       | 类型   | 是否必填 | 备注                      |
-    | ------------- | ---------- | ------ | -------- | ------------------------- |
-    | appealType       | 诉求类型     | int    | 否       |                           |
-    | startTime      | 开始日期(时间格式为yyyy-MM-dd)   | String    | 是       |                           |
-    | endTime | 结束日期(时间格式为yyyy-MM-dd) | String |      是    |                           |
+  | 参数名     | 含义                             | 类型   | 是否必填 | 备注 |
+  | ---------- | -------------------------------- | ------ | -------- | ---- |
+  | appealType | 诉求类型                         | int    | 否       |      |
+  | startTime  | 开始日期(时间格式为yyyy-MM-dd) | String | 是       |      |
+  | endTime    | 结束日期(时间格式为yyyy-MM-dd) | String | 是       |      |
 
 - 返回结果:
 
-    | 中文名        | 字段名 | 类型   | 备注                |
-    | ------------- | ------ | ------ | ------------------- |
-    | 状态码        | code   | int    | 200:成功,其他:错误 |
-    | 成功/错误消息 | msg    | string |                     |
-    | 结果集        | data   | 对象   |                     |
+  | 中文名        | 字段名 | 类型   | 备注                |
+  | ------------- | ------ | ------ | ------------------- |
+  | 状态码        | code   | int    | 200:成功,其他:错误 |
+  | 成功/错误消息 | msg    | string |                     |
+  | 结果集        | data   | 对象   |                     |
 
 - rows 结果集
 
-    | 字段名       | 含义     | 类型   | 备注             |
-    | ------------ | -------- | ------ | ---------------- |
-    | id           | id       | Long   |                  |
-    | sourceName   | 来源名称 | 字符串 |                  |
-    | manageUnit | 主管单位     | 字符串 |                  |
-    | sourceCount      | 诉求总件数 | Long |  |
-    | createTime   | 创建时间 |        |                  |
+  | 字段名      | 含义       | 类型   | 备注 |
+  | ----------- | ---------- | ------ | ---- |
+  | id          | id         | Long   |      |
+  | sourceName  | 来源名称   | 字符串 |      |
+  | manageUnit  | 主管单位   | 字符串 |      |
+  | sourceCount | 诉求总件数 | Long   |      |
+  | createTime  | 创建时间   |        |      |
 
 
 {
@@ -273,7 +273,7 @@
   | 状态码        | code   | int    | 200:成功,其他:错误 |
   | 成功/错误消息 | msg    | string |                     |
   | 结果集        | data   | 对象   |                     |
-  
+
   
 
   ```json
@@ -385,12 +385,12 @@
 
 - 请求参数:
 
-    | 参数名  | 含义                          | 类型   | 是否必填 | 备注                 |
-    | ------- | ----------------------------- | ------ | -------- | -------------------- |
-    | type    | 类型(null,0 = 全部, 1 = 上月) | int    | 否       | type=0,null 时间必填 |
-    | staTime | 开始时间                      | String | 否       |                      |
-    | endTime | 结束时间                      | String | 否       |                      |
-    
+  | 参数名  | 含义                          | 类型   | 是否必填 | 备注                 |
+  | ------- | ----------------------------- | ------ | -------- | -------------------- |
+  | type    | 类型(null,0 = 全部, 1 = 上月) | int    | 否       | type=0,null 时间必填 |
+  | staTime | 开始时间                      | String | 否       |                      |
+  | endTime | 结束时间                      | String | 否       |                      |
+
 - 返回结果:
 
   | 中文名        | 字段名 | 类型   | 备注                |
@@ -425,7 +425,7 @@
   	}
   }
   ```
-  
+
   ```java
   package com.legend.supervision.domain;
   
@@ -1084,30 +1084,30 @@ axios(config)
 
 - 请求参数:
 
-    | 参数名        | 含义       | 类型   | 是否必填 | 备注                      |
-    | ------------- | ---------- | ------ | -------- | ------------------------- |
-    | appealType       | 诉求类型     | int    | 否       |                           |
-    | startTime      | 开始日期(时间格式为yyyy-MM-dd)   | String    | 是       |                           |
-    | endTime | 结束日期(时间格式为yyyy-MM-dd) | String |      是    |                           |
+  | 参数名     | 含义                             | 类型   | 是否必填 | 备注 |
+  | ---------- | -------------------------------- | ------ | -------- | ---- |
+  | appealType | 诉求类型                         | int    | 否       |      |
+  | startTime  | 开始日期(时间格式为yyyy-MM-dd) | String | 是       |      |
+  | endTime    | 结束日期(时间格式为yyyy-MM-dd) | String | 是       |      |
 
 - 返回结果:
 
-    | 中文名        | 字段名 | 类型   | 备注                |
-    | ------------- | ------ | ------ | ------------------- |
-    | 状态码        | code   | int    | 200:成功,其他:错误 |
-    | 成功/错误消息 | msg    | string |                     |
-    | 结果集        | data   | 对象   |                     |
+  | 中文名        | 字段名 | 类型   | 备注                |
+  | ------------- | ------ | ------ | ------------------- |
+  | 状态码        | code   | int    | 200:成功,其他:错误 |
+  | 成功/错误消息 | msg    | string |                     |
+  | 结果集        | data   | 对象   |                     |
 
 - rows 结果集
 
-    | 字段名       | 含义     | 类型   | 备注             |
-    | ------------ | -------- | ------ | ---------------- |
-    | id           | id       | Long   |                  |
-    | extLineNames   | 线路号 | 字符串 |                 |
-    | extLineCodes | 线路编号     | 字符串 |                  |
-    | dealCount      | 数量 | Long |  |
-    | appealType   | 诉求类型数据字典项 |   字符串     |                  |
-    | appealTypeName   | 诉求类型 |     字符串   |                  |
+  | 字段名         | 含义               | 类型   | 备注 |
+  | -------------- | ------------------ | ------ | ---- |
+  | id             | id                 | Long   |      |
+  | extLineNames   | 线路号             | 字符串 |      |
+  | extLineCodes   | 线路编号           | 字符串 |      |
+  | dealCount      | 数量               | Long   |      |
+  | appealType     | 诉求类型数据字典项 | 字符串 |      |
+  | appealTypeName | 诉求类型           | 字符串 |      |
 
 {
     "msg": "操作成功",
@@ -1172,6 +1172,7 @@ axios(config)
 请求参数:开始日期,结束日期
 
 结果:任务总数,未发布任务数,有检查单的任务数, 	没有检查单的任务数,已关闭任务数,进行中的(已发布,未关闭)任务数
+
 - 接口地址:/interface4ext/supervision/inspectionStatement/getInspectionTaskAll
 
 - 请求方式:POST
@@ -1229,6 +1230,7 @@ axios(config)
 请求参数:开始日期,结束日期
 
 结果:检查单位总数,已结束的检查单总数,有不合格的检查单数,整改中的检查单数量,已整改的检查单数量,已结束的检查单数量
+
 - 接口地址:/interface4ext/supervision/inspectionStatement/getInspectionTaskRecordAll
 
 - 请求方式:POST
@@ -1285,16 +1287,18 @@ axios(config)
 #### (3)各整改单位、一段时间内、主办和协办整改的数量排名(正序、倒序)   (yes)--(纪)
 
 ![image-20241121170730172](img/image-20241121170730172.png)
+
 - 接口地址: /interface4ext/supervision/inspectionStatement/getProblemDeptDealRank
 - 请求方式: GET
 - 请求参数:
-```bash
 
+```bash
  startDate string 开始日期 yyyy-MM-dd
  endDate  string  结束日期 yyyy-MM-dd
  isTop int 1:倒序(根据总数据量排名,取多的),0:升序(根据总数据量排名,取少的)
  size int 取多少,默认 20
 ```
+
 - 请求示例 axios
 
 ```javascript
@@ -1367,7 +1371,9 @@ public class ProblemDeptRankVo {
     private String endDate;
 }
 ```
+
 - 结果示例
+
 ```json
 {
     "msg": "操作成功",
@@ -1407,6 +1413,7 @@ public class ProblemDeptRankVo {
 - 接口地址: /interface4ext/supervision/inspectionStatement/getCheeckedDeptTaskRecordRank
 - 请求方式: GET
 - 请求参数
+
 ```bash
      startDate  开始日期 yyyy-MM-dd
      endDate    结束日期 yyyy-MM-dd
@@ -1415,6 +1422,7 @@ public class ProblemDeptRankVo {
 ```
 
 - 结果
+
 ```java
     //开始日期 yyyy-MM-dd
     String startDate;
@@ -1564,18 +1572,18 @@ axios(config)
 
 - 返回结果:
 
-    | 中文名        | 字段名 | 类型   | 备注                |
-    | ------------- | ------ | ------ | ------------------- |
-    | 状态码        | code   | int    | 200:成功,其他:错误 |
-    | 成功/错误消息 | msg    | string |                     |
-    | 结果集        | data   | 对象   |                     |
+  | 中文名        | 字段名 | 类型   | 备注                |
+  | ------------- | ------ | ------ | ------------------- |
+  | 状态码        | code   | int    | 200:成功,其他:错误 |
+  | 成功/错误消息 | msg    | string |                     |
+  | 结果集        | data   | 对象   |                     |
 
 - rows 结果集
 
-    | 字段名       | 含义     | 类型   | 备注             |
-    | ------------ | -------- | ------ | ---------------- |
-    | taskCount      | 各类型任务数量       | Long   |                  |
-    | taskFlagName   | 计划类型名称 | 字符串 |                  |
+  | 字段名       | 含义           | 类型   | 备注 |
+  | ------------ | -------------- | ------ | ---- |
+  | taskCount    | 各类型任务数量 | Long   |      |
+  | taskFlagName | 计划类型名称   | 字符串 |      |
 
 
 {
@@ -1641,10 +1649,12 @@ axios(config)
 - 接口地址: /interface4ext/supervision/inspectionStatement/getCheckingUserSize
 - 请求方式: GET
 - 请求参数:
+
 ```bash
      startDate  开始日期 yyyy-MM-dd
      endDate    结束日期 yyyy-MM-dd
 ```
+
 - 请求示例
 
 ```javascript