更新 '接口文档'
parent
62913e3337
commit
360ccf6a46
@ -29,8 +29,8 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"password": "密码"
|
||||
"phone": "cveo",
|
||||
"password": "cveo123456"
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -38,38 +38,28 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "提示信息",
|
||||
"code": 0,
|
||||
"msg": "请求成功！",
|
||||
"data": {
|
||||
"token": "token字符串",
|
||||
"username": "用户名",
|
||||
"idNumber": "身份证号",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
},
|
||||
"roleList": [ //角色列表
|
||||
"XXX角色",
|
||||
"XX角色"
|
||||
],
|
||||
"departmentList": [ //部门列表
|
||||
"token": "8f6b21a0-fa4b-4241-b5f7-58355048e1f9",
|
||||
"username": "cveo",
|
||||
"idNumber": "",
|
||||
"phone": "cveo",
|
||||
"roleSet": [
|
||||
{
|
||||
"id": "xxxxxxxx",
|
||||
"name": "XXX部门",
|
||||
"parent": "上级部门id", //若无上级部门则此字段为null
|
||||
"children": [] //下级部门列表
|
||||
},
|
||||
{
|
||||
"id": "xxxxxxxx",
|
||||
"name": "XXX部门",
|
||||
"parent": "上级部门id", //若无上级部门则此字段为null
|
||||
"children": [] //下级部门列表
|
||||
},
|
||||
...
|
||||
]
|
||||
"name": "管理员",
|
||||
"authoritySet": [
|
||||
"管理员"
|
||||
]
|
||||
}
|
||||
],
|
||||
"departmentList": [],
|
||||
"administrativeArea": null
|
||||
}
|
||||
}
|
||||
|
||||
Response code: 200; Time: 923ms; Content length: 224 bytes
|
||||
|
||||
~~~
|
||||
|
||||
-
|
||||
@ -88,11 +78,9 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"roleList":[ //新的角色列表
|
||||
"管理员",
|
||||
"流调人员",
|
||||
...
|
||||
"phone": "13995833300",
|
||||
"roleSet": [
|
||||
"测试角色"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
@ -138,9 +126,13 @@
|
||||
{
|
||||
"username": "用户名",
|
||||
"phone": "电话号码",
|
||||
"roleList": [
|
||||
"XXX角色",
|
||||
"XX角色"
|
||||
"roleSet": [
|
||||
{
|
||||
"name":"XXX",
|
||||
"authoritySet":[
|
||||
"XXX权限"
|
||||
]
|
||||
}
|
||||
],
|
||||
"departmentList": [
|
||||
|
||||
@ -155,7 +147,7 @@
|
||||
|
||||
|
||||
|
||||
### 4、删除用户
|
||||
### 4、管理员删除用户
|
||||
|
||||
- url：`/user/user`
|
||||
|
||||
@ -195,13 +187,13 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"username": "用户名",
|
||||
"idNumber": "身份证号",
|
||||
"phone": "13995833308",
|
||||
"username": "Pope8",
|
||||
"idNumber": "4207042000022700118",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
"province": "湖北省",
|
||||
"city": "鄂州市",
|
||||
"county": "鄂城区"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
@ -258,14 +250,14 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"idNumber": "身份证号",
|
||||
"username": "用户名",
|
||||
"phone": "手机号",
|
||||
"password": "密码",
|
||||
"idNumber": "4207042000227001X",
|
||||
"username": "Pope10",
|
||||
"phone": "1399583330X",
|
||||
"password": "13995833308",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
"province": "湖北省",
|
||||
"city": "鄂州市",
|
||||
"county": "鄂城区"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
@ -300,15 +292,14 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "新角色名",
|
||||
"authorityList": [ //权限列表
|
||||
"name": "新角色名",
|
||||
"authoritySet": [ //权限列表
|
||||
"XXX权限",
|
||||
"XXXX权限",
|
||||
...
|
||||
"XXXX权限"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
@ -333,7 +324,7 @@
|
||||
| :---------: | :------: | :------: | :---------------: |
|
||||
| pageSize | 是 | int | 页大小，默认30 |
|
||||
| currentPage | | int | 当前页数，从0开始 |
|
||||
| roleName | 是 | String | 权限名模糊匹配 |
|
||||
| name | 是 | String | 权限名模糊匹配 |
|
||||
|
||||
- 返回数据
|
||||
|
||||
@ -347,8 +338,8 @@
|
||||
"currentPage": 0,
|
||||
"data": [
|
||||
{
|
||||
"roleName": "流调人员",
|
||||
"authList": [
|
||||
"name": "流调人员",
|
||||
"authoritySet": [
|
||||
"查询调查记录的权限",
|
||||
"修改调查记录权限",
|
||||
"分析调查记录权限",
|
||||
@ -358,18 +349,12 @@
|
||||
"查询流调人员信息的权限",
|
||||
"查询调查对象信息的权限"
|
||||
]
|
||||
},
|
||||
{
|
||||
"roleName": "管理员",
|
||||
"authList": [
|
||||
"管理员"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
### 3、删除角色
|
||||
@ -384,7 +369,7 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "XXX角色"
|
||||
"name": "XXX角色"
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -412,8 +397,8 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "XXX角色",
|
||||
"authorityList": [
|
||||
"name": "XXX角色",
|
||||
"authoritySet": [
|
||||
"XXX权限",
|
||||
"XX权限"
|
||||
]
|
||||
@ -486,7 +471,10 @@
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
},
|
||||
"projectSet": [
|
||||
"XX项目"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -511,12 +499,12 @@
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :---------: | :------: | :------: | :------------------: |
|
||||
| userPhone | | String | 分配的用户的电话号码 |
|
||||
| userPhone | 是 | String | 分配的用户的电话号码 |
|
||||
| state | 是 | String | 已调查/待调查 |
|
||||
| province | 是 | String | 行政区划省份 |
|
||||
| city | 是 | String | 行政区划城市 |
|
||||
| county | 是 | String | 行政区划区县 |
|
||||
| currentPage | 是 | int | 当前页数，默认为0 |
|
||||
| currentPage | | int | 当前页数，从0开始 |
|
||||
| pageSize | 是 | int | 当前页大小，默认为30 |
|
||||
|
||||
- 返回数据
|
||||
@ -537,7 +525,7 @@
|
||||
"msg": "备注",
|
||||
"userInfo": { //分配给的用户的信息
|
||||
"idNumber": "身份证号",
|
||||
"name": "姓名",
|
||||
"username": "姓名",
|
||||
"phone": "电话号码"
|
||||
},
|
||||
"gender": "男/女",
|
||||
@ -545,13 +533,16 @@
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
},
|
||||
"projectSet":[
|
||||
"XXX项目"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
### 3、修改调查对象
|
||||
@ -576,7 +567,10 @@
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
},
|
||||
"projectSet": [
|
||||
"XXX项目"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -626,7 +620,7 @@
|
||||
|
||||
### 1、查询调查记录
|
||||
|
||||
- url：`/investigationRecord/investigationRecord`
|
||||
- url：`/record/record`
|
||||
|
||||
- method：`GET`
|
||||
|
||||
@ -639,7 +633,7 @@
|
||||
| idNumber | 是 | String | 调查对象的身份证号 |
|
||||
| version | 是 | String | 调查记录版本 |
|
||||
| questionnaireNumber | 是 | String | 调查记录问卷编号 |
|
||||
| currentPage | 是 | int | 当前页数，默认为0 |
|
||||
| currentPage | | int | 当前页数，从0开始 |
|
||||
| pageSize | 是 | int | 页大小，默认为30 |
|
||||
|
||||
>说明
|
||||
@ -655,6 +649,8 @@
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": {
|
||||
"idNumber": "调查对象身份证号",
|
||||
"userPhone": "分配的用户电话号码"
|
||||
"value": {
|
||||
},
|
||||
"operationInfoList": [
|
||||
@ -679,14 +675,14 @@
|
||||
"version": "版本信息",
|
||||
"state": "已审核/待审核/已删除/已归档"
|
||||
}
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
### 2、查询待审核调查记录数量
|
||||
|
||||
- url：`/investigationRecord/underReviewRecordCount`
|
||||
- url：`/record/underReviewRecordCount`
|
||||
|
||||
- method：`GET`
|
||||
|
||||
@ -712,7 +708,7 @@
|
||||
|
||||
### 3、审核待审核调查记录
|
||||
|
||||
- url：`/investigationRecord/underReviewRecord`
|
||||
- url：`/record/underReviewRecord`
|
||||
|
||||
- method**：**`PUT`
|
||||
|
||||
@ -724,7 +720,7 @@
|
||||
{
|
||||
"idNumber": "调查对象身份证号",
|
||||
"pass": "true/false", //审核是否通过
|
||||
"passInfo": "审核信息",
|
||||
"msg": "审核信息",
|
||||
"reviewerPhone": "审核者电话号码"
|
||||
}
|
||||
~~~
|
||||
@ -743,7 +739,7 @@
|
||||
|
||||
### 4、修改已审核调查记录
|
||||
|
||||
- url：`/investigationRecord/investigationRecord`
|
||||
- url：`/record/record`
|
||||
|
||||
- method：`PUT`
|
||||
|
||||
@ -754,8 +750,10 @@
|
||||
~~~json
|
||||
{
|
||||
"value": {
|
||||
...
|
||||
}
|
||||
|
||||
},
|
||||
"userPhone": "执行修改操作的用户的电话号码",
|
||||
"msg": "备注";
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -773,7 +771,7 @@
|
||||
|
||||
### 5、提交调查记录
|
||||
|
||||
- url：`/investigationRecord/investigationRecord`
|
||||
- url：`/record/record`
|
||||
|
||||
- method：`POST`
|
||||
|
||||
@ -783,9 +781,12 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"idNumber": "调查对象身份证号",
|
||||
"userPhone": "分配的用户的电话号码"
|
||||
"value": {
|
||||
...
|
||||
}
|
||||
},
|
||||
"msg": "备注"
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -844,7 +845,8 @@
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
"wordTemplate": "",
|
||||
"config": {}
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -872,7 +874,7 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "字段名"
|
||||
"name": "XXX"
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -908,7 +910,8 @@
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
"wordTemplate": "",
|
||||
"config": {}
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -936,7 +939,7 @@
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "字段名"
|
||||
"name": "XXX"
|
||||
}
|
||||
~~~
|
||||
|
||||
@ -955,9 +958,10 @@
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
"wordTemplate": "",
|
||||
"config": {}
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
~~~
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user