更新 '接口文档'
parent
ccaf1621b1
commit
3d4400b03b
@ -1,12 +1,897 @@
|
||||
# 流调系统后台接口文档
|
||||
-----------
|
||||
# 流行病调查接口文档
|
||||
|
||||
> 说明
|
||||
|
||||
- 以下接口返回数据中只包含操作成功的数据，若操作失败出现异常（如接口参数有误）则返回数据格式如下：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "提示信息，如XXX参数有误"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 后端返回给前端的数据中所有日期数据格式均为`yyyy-MM-dd HH:mm:ss`
|
||||
|
||||
|
||||
|
||||
## 用户部分
|
||||
|
||||
### 1、登录
|
||||
|
||||
- **url：**`/user/login`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"password": "密码"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "提示信息",
|
||||
"data": {
|
||||
"token": "token字符串",
|
||||
"username": "用户名",
|
||||
"idNumber": "身份证号",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
},
|
||||
"roleList": [ //角色列表
|
||||
"XXX角色",
|
||||
"XX角色"
|
||||
],
|
||||
"departmentList": [ //部门列表
|
||||
{
|
||||
"id": "xxxxxxxx",
|
||||
"name": "XXX部门",
|
||||
"parent": "上级部门id", //若无上级部门则此字段为null
|
||||
"children": [] //下级部门列表
|
||||
},
|
||||
{
|
||||
"id": "xxxxxxxx",
|
||||
"name": "XXX部门",
|
||||
"parent": "上级部门id", //若无上级部门则此字段为null
|
||||
"children": [] //下级部门列表
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
-
|
||||
|
||||
|
||||
|
||||
### 2、修改用户角色
|
||||
|
||||
- **url：**`/user/userRole`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"roleList":[ //新的角色列表
|
||||
"管理员",
|
||||
"流调人员",
|
||||
...
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 3、查询用户列表
|
||||
|
||||
- **url：**`/user/user`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- 参数列表
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :---------: | :------: | :------: | :---------------: |
|
||||
| username | 是 | String | 用户名模糊查询 |
|
||||
| phone | 是 | String | 电话号码精确查询 |
|
||||
| pageSize | 是 | int | 页大小，默认为30 |
|
||||
| currentPage | | int | 当前页数，从0开始 |
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": {
|
||||
"totalCount": "筛选后的总数",
|
||||
"currentPage": "当前页数",
|
||||
"pageSize": "页大小",
|
||||
"data": [
|
||||
{
|
||||
"username": "用户名",
|
||||
"phone": "电话号码",
|
||||
"roleList": [
|
||||
"XXX角色",
|
||||
"XX角色"
|
||||
],
|
||||
"departmentList": [
|
||||
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
### 4、删除用户
|
||||
|
||||
- **url：**`/user/user`
|
||||
|
||||
- **method：**`DELETE`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户的电话号码"
|
||||
}"
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "删除成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 5、管理员修改用户信息
|
||||
|
||||
- **url：**`/user/user`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码",
|
||||
"username": "用户名",
|
||||
"idNumber": "身份证号",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 6、管理员重置用户密码
|
||||
|
||||
- **url：**`/user/pwd`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"phone": "用户电话号码"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "重置成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 7、管理员创建用户
|
||||
|
||||
- **url：**`/user/user`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"idNumber": "身份证号",
|
||||
"username": "用户名",
|
||||
"phone": "手机号",
|
||||
"password": "密码",
|
||||
"administrativeArea": {
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "创建成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 角色部分
|
||||
|
||||
### 1、添加角色
|
||||
|
||||
- **url：**`/role/role`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "新角色名",
|
||||
"authorityList": [ //权限列表
|
||||
"XXX权限",
|
||||
"XXXX权限",
|
||||
...
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "创建成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 2、查询角色列表
|
||||
|
||||
- **url：**`/role/role`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :---------: | :------: | :------: | :---------------: |
|
||||
| pageSize | 是 | int | 页大小，默认30 |
|
||||
| currentPage | | int | 当前页数，从0开始 |
|
||||
| roleName | 是 | String | 权限名模糊匹配 |
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": {
|
||||
"pageSize": 30,
|
||||
"totalCount": 2,
|
||||
"currentPage": 0,
|
||||
"data": [
|
||||
{
|
||||
"roleName": "流调人员",
|
||||
"authList": [
|
||||
"查询调查记录的权限",
|
||||
"修改调查记录权限",
|
||||
"分析调查记录权限",
|
||||
"增删改调查对象信息的权限",
|
||||
"提交调查记录权限",
|
||||
"删除调查记录权限",
|
||||
"查询流调人员信息的权限",
|
||||
"查询调查对象信息的权限"
|
||||
]
|
||||
},
|
||||
{
|
||||
"roleName": "管理员",
|
||||
"authList": [
|
||||
"管理员"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 3、删除角色
|
||||
|
||||
- **url：**`/role/role`
|
||||
|
||||
- **method：**`DELETE`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "XXX角色"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "删除成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 4、修改角色权限列表
|
||||
|
||||
- **url：**`/role/role`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"roleName": "XXX角色",
|
||||
"authorityList": [
|
||||
"XXX权限",
|
||||
"XX权限"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 5、查看所有权限列表
|
||||
|
||||
- **url：**`/role/authorityList`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
无
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": [
|
||||
"XXX权限",
|
||||
"XX权限",
|
||||
"XXXXX权限"
|
||||
]
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 调查对象部分
|
||||
|
||||
### 1、创建待调查对象
|
||||
|
||||
- **url：**`/respondent/respondent`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"idNumber": "调查对象身份证号",
|
||||
"phone": "调查对象的手机号",
|
||||
"name": "调查对象姓名",
|
||||
"msg": "备注",
|
||||
"userPhone": "分配给的用户的电话号码",
|
||||
"gender": "男/女",
|
||||
"administrativeArea": { //调查对象的行政区划
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "创建成功",
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 2、查询调查对象
|
||||
|
||||
- **url：**`/respondent/respondent`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :---------: | :------: | :------: | :------------------: |
|
||||
| userPhone | | String | 分配的用户的电话号码 |
|
||||
| state | 是 | String | 已调查/待调查 |
|
||||
| province | 是 | String | 行政区划省份 |
|
||||
| city | 是 | String | 行政区划城市 |
|
||||
| county | 是 | String | 行政区划区县 |
|
||||
| currentPage | 是 | int | 当前页数，默认为0 |
|
||||
| pageSize | 是 | int | 当前页大小，默认为30 |
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": {
|
||||
"totalCount": "筛选后总数量",
|
||||
"currentPage": "当前页数",
|
||||
"pageSize": "页大小",
|
||||
"data":[
|
||||
{
|
||||
"idNumber": "调查对象身份证号",
|
||||
"phone": "调查对象",
|
||||
"name": "调查对象姓名",
|
||||
"msg": "备注",
|
||||
"userInfo": { //分配给的用户的信息
|
||||
"idNumber": "身份证号",
|
||||
"name": "姓名",
|
||||
"phone": "电话号码"
|
||||
},
|
||||
"gender": "男/女",
|
||||
"administrativeArea": { //调查对象的行政区划
|
||||
"province": "XX省",
|
||||
"city": "XX市",
|
||||
"county": "XX区"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 调查记录
|
||||
|
||||
### 1、查询调查记录
|
||||
|
||||
- **url：**`/investigationRecord/investigationRecord`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :-----------------: | :------: | :------: | :-------------------------: |
|
||||
| userPhone | | String | 分配给的用户的电话号码 |
|
||||
| state | 是 | String | 已审核/待审核/已删除/已归档 |
|
||||
| idNumber | 是 | String | 调查对象的身份证号 |
|
||||
| version | 是 | String | 调查记录版本 |
|
||||
| questionnaireNumber | 是 | String | 调查记录问卷编号 |
|
||||
| currentPage | 是 | int | 当前页数，默认为0 |
|
||||
| pageSize | 是 | int | 页大小，默认为30 |
|
||||
|
||||
>说明
|
||||
|
||||
若不传state参数，则默认查询状态为`已审核与未审核`的调查记录。
|
||||
|
||||
|
||||
|
||||
- 返回数据：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": {
|
||||
"value": {
|
||||
},
|
||||
"operationInfoList": [
|
||||
{
|
||||
"type": "提交/修改/删除/恢复/审核",
|
||||
"date": "操作时间",
|
||||
"userPhone": "操作者电话号码",
|
||||
"version": "版本信息",
|
||||
"msg": "备注信息",
|
||||
"result": "操作结果"
|
||||
},
|
||||
{
|
||||
"type": "提交/修改/删除/恢复/审核",
|
||||
"date": "操作时间",
|
||||
"userPhone": "操作者电话号码",
|
||||
"version": "版本信息",
|
||||
"msg": "备注信息",
|
||||
"result": "操作结果"
|
||||
},
|
||||
...
|
||||
],
|
||||
"version": "版本信息",
|
||||
"state": "已审核/待审核/已删除/已归档"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 2、查询待审核调查记录数量
|
||||
|
||||
- **url：**`/investigationRecord/underReviewRecordCount`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 参数说明 |
|
||||
| :-------: | :------: | :------: | :------------------: |
|
||||
| userPhone | | String | 分配的用户的电话号码 |
|
||||
|
||||
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "查询成功",
|
||||
"data": 100 //数量
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 3、审核待审核调查记录
|
||||
|
||||
- **url：**`/investigationRecord/underReviewRecord`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"idNumber": "调查对象身份证号",
|
||||
"pass": "true/false", //审核是否通过
|
||||
"passInfo": "审核信息",
|
||||
"reviewerPhone": "审核者电话号码"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "审核成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 4、修改已审核调查记录
|
||||
|
||||
- **url：**`/investigationRecord/investigationRecord`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"value": {
|
||||
...
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功，等待审核",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 5、提交调查记录
|
||||
|
||||
- **url：**`/investigationRecord/investigationRecord`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"value": {
|
||||
...
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "提交成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 6、导出为Word
|
||||
|
||||
- url：`/investigationRecord/record2word`
|
||||
|
||||
- method：`GET`
|
||||
|
||||
- 参数列表
|
||||
|
||||
| 参数名 | 是否可选 | 参数类型 | 备注 |
|
||||
| :------: | :------: | :------: | :--------------------------: |
|
||||
| idNumber | | String | 调查对象身份证号 |
|
||||
| token | | String | 以后还是将这个参数放进header |
|
||||
|
||||
- 返回数据
|
||||
|
||||
无
|
||||
|
||||
## 用户
|
||||
|
||||
## 角色
|
||||
|
||||
## 流调记录
|
||||
|
||||
## 审核
|
||||
|
||||
## 元数据
|
||||
|
||||
### 1、创建元数据
|
||||
|
||||
- **url：**`/metadata/metadata`
|
||||
|
||||
- **method：**`POST`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "XXX",
|
||||
"form": {},
|
||||
"fieldToName": [
|
||||
{
|
||||
"field": "",
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "创建成功"
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 2、删除元数据
|
||||
|
||||
- **url：**`/metadata/metadata`
|
||||
|
||||
- **method：**`DELETE`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "字段名"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "删除成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 3、修改元数据
|
||||
|
||||
- **url：**`/metadata/metadata`
|
||||
|
||||
- **method：**`PUT`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "XXX",
|
||||
"form": {},
|
||||
"fieldToName": [
|
||||
{
|
||||
"field": "",
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功",
|
||||
"data": null
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
### 4、查询元数据
|
||||
|
||||
- **url：**`/metadata/metadata`
|
||||
|
||||
- **method：**`GET`
|
||||
|
||||
- **Content-Type：**`application/json`
|
||||
|
||||
- 参数列表：
|
||||
|
||||
~~~json
|
||||
{
|
||||
"name": "字段名"
|
||||
}
|
||||
~~~
|
||||
|
||||
- 返回数据
|
||||
|
||||
~~~json
|
||||
{
|
||||
"code": "状态码",
|
||||
"msg": "修改成功",
|
||||
"data": {
|
||||
"name": "XXX",
|
||||
"form": {},
|
||||
"fieldToName": [
|
||||
{
|
||||
"field": "",
|
||||
"name": ""
|
||||
}
|
||||
],
|
||||
"wordTemplate": ""
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user