更新 '接口文档'

%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3.md

@@ -49,12 +49,16 @@
               {
                   "name": "管理员",
                   "authoritySet": [
-                      "管理员"
+                      "XXX权限"
                   ]
               }
           ],
           "departmentList": [],
-          "administrativeArea": null
+          "administrativeArea": {
+              "province":"XXX",
+              "city":"XXX",
+              "county":"XXX"
+          }
       }
   }
   
@@ -99,7 +103,7 @@
 
 ### 3、查询用户列表
 
-- url：`/user/user`
+- url：`/user/userList`
 
 - method：`GET`
 
@@ -124,6 +128,7 @@
           "pageSize": "页大小",
           "data": [
               {
+                  "idNumber":"XXXXX",
                   "username": "用户名",
                   "phone": "电话号码",
                   "roleSet": [
@@ -136,7 +141,12 @@
                   ],
                   "departmentList": [
   
-                  ]
+                  ],
+                  "administrativeArea": {
+                      "province":"XXX",
+                      "city":"XXX",
+                      "county":"XXX"
+                  }
               }
           ]
       }
@@ -314,7 +324,7 @@
 
 ### 2、查询角色列表
 
-- url：`/role/role`
+- url：`/role/roleList`
 
 - method：`GET`
 
@@ -472,9 +482,8 @@
           "city": "XX市",
           "county": "XX区"
       },
-      "projectSet": [
+      "userPhone":"XXXX",
-          "XX项目"
+      "projectName":"XXXX"
-      ]
   }
   ~~~
   
@@ -489,9 +498,9 @@
 
   
 
-### 2、查询调查对象
+### 2、查询调查对象列表
 
-- url：`/respondent/respondent`
+- url：`/respondent/respondentList`
 
 - method：`GET`
 
@@ -500,7 +509,11 @@
   |   参数名    | 是否可选 | 参数类型 |       参数说明       |
   | :---------: | :------: | :------: | :------------------: |
   |  userPhone  |    是    |  String  | 分配的用户的电话号码 |
-  |    state    |    是    |  String  |    已调查/待调查     |
+  | projectName |    是    |  String  |        项目名        |
+  |    state    |    是    |  String  | 已调查/待调查/已归档 |
+  |  idNumber   |    是    |  String  |       身份证号       |
+  |    name     |    是    |  String  |    姓名，模糊查询    |
+  |    phone    |    是    |  String  |       电话号码       |
   |  province   |    是    |  String  |     行政区划省份     |
   |    city     |    是    |  String  |     行政区划城市     |
   |   county    |    是    |  String  |     行政区划区县     |
@@ -523,20 +536,19 @@
                   "phone": "调查对象",
                   "name": "调查对象姓名",
                   "msg": "备注",
-                  "userInfo": {				//分配给的用户的信息
-                      "idNumber": "身份证号",
-                      "username": "姓名",
-                      "phone": "电话号码"
-                  },
                   "gender": "男/女",
                   "administrativeArea": {		//调查对象的行政区划
                       "province": "XX省",
                       "city": "XX市",
                       "county": "XX区"
                   },
-                  "projectSet":[
+                  "userInfo": {				//分配给的用户的信息
-                      "XXX项目"
+                      "idNumber": "身份证号",
-                  ]
+                      "username": "姓名",
+                      "phone": "电话号码"
+                  },
+                  "projectName":"XXX",
+                  "state":"XXX"
               }
           ]
     	}
@@ -568,9 +580,7 @@
           "city": "XX市",
           "county": "XX区"
       },
-      "projectSet": [
+      "projectName":"XXX"
-          "XXX项目"
-      ]
   }
   ~~~
   
@@ -598,7 +608,8 @@
 
   ~~~json
   {
-      "idNumber": "XXXXXXX"
+      "idNumber": "XXXXXXX",
+      "projectName":"XXXX"
   }
   ~~~
 
@@ -618,9 +629,9 @@
 
 ## 调查记录
 
-### 1、查询调查记录
+### 1、查询调查记录列表
 
-- url：`/record/record`
+- url：`/record/recordList`
 
 - method：`GET`
 
@@ -629,7 +640,7 @@
   |       参数名        | 是否可选 | 参数类型 |          参数说明           |
   | :-----------------: | :------: | :------: | :-------------------------: |
   |      userPhone      |    是    |  String  |   分配给的用户的电话号码    |
-  |       project       |    是    |  String  |           项目名            |
+  |     projectName     |    是    |  String  |           项目名            |
   |        state        |    是    |  String  | 已审核/待审核/已删除/已归档 |
   |      idNumber       |    是    |  String  |     调查对象的身份证号      |
   |       version       |    是    |  String  |        调查记录版本         |
@@ -652,11 +663,7 @@
       "data": {
           "idNumber": "调查对象身份证号",
           "userPhone": "分配的用户电话号码",
-          "projectSet":[
+          "projectName":"XXX",
-              
-          ],
-          "value": {
-          },
           "operationInfoList": [
               {
                   "type": "提交/修改/删除/恢复/审核",
@@ -673,8 +680,7 @@
                   "version": "版本信息",
                   "msg": "备注信息",
                   "result": "操作结果"
-              },
+              }
-      		...
           ],
         	"version": "版本信息",
           "state": "已审核/待审核/已删除/已归档"
@@ -684,7 +690,37 @@
   
 
 
-### 2、查询待审核调查记录数量
+
+### 2、查询调查记录value字段
+
+- url：`/record/recordValues`
+
+- method：`GET`
+
+- 参数列表
+
+  |   参数名    | 是否可选 | 参数类型 | 参数备注 |
+  | :---------: | :------: | :------: | :------: |
+  |  idNumber   |          |  String  | 身份证号 |
+  | projectName |          |  String  |  项目名  |
+  |   version   |    是    |  String  |   版本   |
+
+- 返回数据
+
+  ~~~json
+  {
+      "code":"XXX",
+      "msg":"请求成功",
+      "data":{
+          "XXX":"XXX",
+          "XXX":"XXX"
+      }
+  }
+  ~~~
+
+  
+
+### 3、查询待审核调查记录数量
 
 - url：`/record/underReviewRecordCount`
 
@@ -710,7 +746,7 @@
 
 
 
-### 3、审核待审核调查记录
+### 4、审核待审核调查记录
 
 - url：`/record/underReviewRecord`
 
@@ -723,7 +759,7 @@
   ~~~json
   {
       "idNumber": "调查对象身份证号",
-      "project": "项目名"
+      "projectName": "项目名"
       "pass": "true/false",			//审核是否通过
       "msg": "审核信息",
       "reviewerPhone": "审核者电话号码"
@@ -742,7 +778,7 @@
 
 
 
-### 4、修改已审核调查记录
+### 5、修改已审核调查记录
 
 - url：`/record/record`
 
@@ -754,7 +790,9 @@
 
   ~~~json
   {
-      "value": {
+      "idNumber":"",
+      "projectName":"",
+      "values": {
          
       },
       "userPhone": "执行修改操作的用户的电话号码",
@@ -774,7 +812,7 @@
 
 
 
-### 5、提交调查记录
+### 6、提交调查记录
 
 - url：`/record/record`
 
@@ -788,10 +826,8 @@
   {
       "idNumber": "调查对象身份证号",
       "userPhone": "分配的用户的电话号码",
-      "projectSet": [
+      "projectName": "",
-          
+      "values": {
-      ],
-      "value": {
           ...
       },
       "msg": "备注"
@@ -810,22 +846,7 @@
 
 
 
-### 6、导出为Word
+### 7、导出为Word
-
-- url：`/investigationRecord/record2word`
-
-- method：`GET`
-
-- 参数列表
-
-  |  参数名  | 是否可选 | 参数类型 |             备注             |
-  | :------: | :------: | :------: | :--------------------------: |
-  | idNumber |          |  String  |       调查对象身份证号       |
-|  token   |          |  String  | 以后还是将这个参数放进header |
-  
-- 返回数据
-
-  无
 
 
 
@@ -853,7 +874,6 @@
               "name": ""
           }
       ],
-      "wordTemplate": "",
       "config": {}
   }
   ~~~
@@ -918,7 +938,6 @@
               "name": ""
           }
       ],
-      "wordTemplate": "",
       "config": {}
   }
   ~~~
@@ -935,14 +954,12 @@
 
   
 
-### 4、查询元数据
+### 4、查询元数据列表
 
-- url：`/metadata/metadata`
+- url：`/metadata/metadataList`
 
 - method：`GET`
 
-- Content-Type：`application/json`
-
 - 参数列表：
 
   ~~~json
@@ -970,6 +987,214 @@
           "config": {}
       }
   }
-~~~
+  ~~~
+
+
+
+### 5、精确查询元数据
+
+- url：`/metadata/metadata`
+
+- method：`GET`
+
+- 参数列表：
+
+  | 参数名 | 是否可选 | 参数类型 | 参数说明 |
+  | :----: | :------: | :------: | :------: |
+  |  name  |          |  String  |   名字   |
+
+- 返回数据
+
+  ~~~json
+  {
+      "code":"XXX",
+      "msg":"XXX",
+      "data":{
+          "name": "XXX",
+          "form": {},
+          "fieldToName": [
+              {
+                  "field": "",
+                  "name": ""
+              }
+          ],
+          "wordTemplate": "",
+          "config": {}
+      }
+  }
+  ~~~
+
+  
+
+
+
+
+
+
+
+## 项目
+
+### 1、创建项目
+
+- url：`/project/project`
+
+- method：`POST`
+
+- Content-Type：`application/json`
+
+- 参数列表：
+
+  ~~~json
+  {
+      "name":"XXX",
+      "detail":"XXX",
+      "metaDataName":"XXX",
+      "startTime":"yyyy-MM-dd HH:mm:ss",
+      "endTime":"yyyy-MM-dd HH:mm:ss",
+      "userPhone":""
+  }
+  ~~~
+
+- 返回数据
+
+  ~~~json
+  {
+      "code": "状态码",
+      "msg": "删除成功",
+      "data": null
+  }
+  ~~~
+
+  
+
+### 2、查询项目列表
+
+- url：`/project/projectList`
+
+- method：`GET`
+
+- 参数列表：
+
+  |   参数名    | 是否可选 | 参数类型 | 参数说明 |
+  | :---------: | :------: | :------: | :------: |
+  |    name     |    是    |  String  |   名字   |
+  | currentPage |          |   int    | 当前页数 |
+  |  pageSize   |    是    |   int    |  页大小  |
+
+- 返回数据
+
+  ~~~json
+  {
+      "code": "状态码",
+      "msg": "查询成功",
+      "data": {
+          "totalCount": "筛选后总数量",
+          "currentPage": "当前页数",
+          "pageSize": "页大小",
+          "data":[
+              {
+                  "name":"XXX",
+                  "detail":"XXX",
+                  "metaDataName":"XXX",
+                  "startTime":"yyyy-MM-dd HH:mm:ss",
+                  "endTime":"yyyy-MM-dd HH:mm:ss",
+                  "state":"XXX"
+              }
+          ]
+    	}
+  }
+  ~~~
+
+  
+
+### 3、查询待调查对象数与调查对象总数
+
+- url：`/project/respondentCount`
+
+- method：`POST`
+
+- Content-Type：`application/json`
+
+- 参数列表：
+
+  ~~~json
+  {
+      "name":"XXX"
+  }
+  ~~~
+
+- 返回数据
+
+  ~~~json
+  {
+      "code":"XXX",
+      "msg":"XXX",
+      "data":{
+          "respondentCount":"总数",
+          "notInvestigatedRespondentCount":"待调查对象数量"
+      }
+  }
+  ~~~
+
+
+
+### 4、修改项目状态
+
+- url：`/project/projectState`
+
+- method：`PUT`
+
+- Content-Type：`application/json`
+
+- 参数列表：
+
+  ~~~json
+  {
+      "name":"XXX",
+      "state":"XXX"
+  }
+  ~~~
+
+- 返回数据
+
+  ~~~json
+  {
+      "code": "状态码",
+      "msg": "修改成功",
+      "data": null
+  }
+  ~~~
+
+
+
+### 5、修改调查对象信息
+
+- url：`/project/project`
+
+- method：`PUT`
+
+- Content-Type：`application/json`
+
+- 参数列表：
+
+  ~~~json
+  {
+      "name":"XXX",
+      "detail":"XXX",
+      "startTime":"yyyy-MM-dd HH:mm:ss",
+      "endTime":"yyyy-MM-dd HH:mm:ss",
+      "userPhone":""
+  }
+  ~~~
+
+- 返回数据
+
+  ~~~json
+  {
+      "code": "状态码",
+      "msg": "修改成功",
+      "data": null
+  }
+  ~~~