|
@@ -1,1114 +1,1639 @@
|
|
|
# acl提供给web的接口
|
|
|
|
|
|
-## 鉴权接口
|
|
|
+**测试环境**: http://192.168.50.3:12128
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/api/verification
|
|
|
-Content-Type: application/json
|
|
|
+**正式环境**: http://192.168.70.125:12128
|
|
|
|
|
|
-{
|
|
|
- "token": "token",
|
|
|
- "system": "web",
|
|
|
- "fromSystem": "test"
|
|
|
-}
|
|
|
-```
|
|
|
+[TOC]
|
|
|
|
|
|
-```json
|
|
|
-{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "userName": "张三",
|
|
|
- "list": [
|
|
|
- {
|
|
|
- "id": 1,
|
|
|
- "name": "工单处理",
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "priority": 0
|
|
|
- },
|
|
|
- {
|
|
|
- "id": 2,
|
|
|
- "name": "工单答复",
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "priority": 0
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
+# 用户
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-id: 功能id
|
|
|
+## 修改用户
|
|
|
|
|
|
-name: 功能名称
|
|
|
|
|
|
-url: 功能链接
|
|
|
+**接口地址**:`/api/web/user/update`
|
|
|
|
|
|
-webIcon: web图标链接
|
|
|
|
|
|
-priority: 显示优先级,值越大越靠前
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-### 特殊情况
|
|
|
|
|
|
-- 无任何权限
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-```json
|
|
|
-{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "userName": "张三",
|
|
|
- "list": null
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
|
|
|
-## 查询角色说明接口
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/role/list
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
-{
|
|
|
- "current": 1,
|
|
|
- "pageSize": 10,
|
|
|
- "roleName": "工单查询",
|
|
|
- "system": "flow"
|
|
|
-}
|
|
|
-```
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
|
|
|
-```json
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
+ "email": "",
|
|
|
+ "userId": 0,
|
|
|
+ "roles": [
|
|
|
{
|
|
|
+ "roleId": 0,
|
|
|
+ "cityId": 0,
|
|
|
"roleName": "工单查询",
|
|
|
- "system": "flow",
|
|
|
- "systemName": "流程"
|
|
|
- },
|
|
|
- {
|
|
|
- "roleName": "工单答复",
|
|
|
- "system": "flow",
|
|
|
- "systemName": "流程"
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "functionId": 0
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-roleName: 角色名称
|
|
|
+**请求参数**:
|
|
|
|
|
|
-system: 系统
|
|
|
|
|
|
-current: 页码
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|updateUserDto|UpdateUserDto|body|true|UpdateUserDto|UpdateUserDto|
|
|
|
+|  email|邮箱||false|string||
|
|
|
+|  userId|用户id||true|integer(int32)||
|
|
|
+|  roles|角色列表||false|array|AddUserRoleDto|
|
|
|
+|    roleId|角色id||true|integer||
|
|
|
+|    cityId|地市id||true|integer||
|
|
|
+|    roleName|角色名称||true|string||
|
|
|
+|    cityName|地市名称||true|string||
|
|
|
+|    functionId|功能id||false|integer||
|
|
|
|
|
|
-pageSize: 每页个数
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**响应状态**:
|
|
|
|
|
|
-total: 数据总数
|
|
|
|
|
|
-roleName: 角色名称
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|default|default response|RObject|
|
|
|
+|无法修改非本地市用户|{"success":false,"code":0,"message":"无法修改非本地市用户","data":null}||
|
|
|
|
|
|
-system: 系统
|
|
|
|
|
|
-systemName: 系统中文名称
|
|
|
+**响应参数**:
|
|
|
|
|
|
-## 查询模块列表接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/function/list
|
|
|
-Content-Type: application/json
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|object||
|
|
|
|
|
|
-{
|
|
|
- "current": 1,
|
|
|
- "pageSize": 10,
|
|
|
- "functionName": "工单查询",
|
|
|
- "client": 1,
|
|
|
- "system": "flow"
|
|
|
-}
|
|
|
-```
|
|
|
|
|
|
-```json
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "total": 100,
|
|
|
- "list": [
|
|
|
- {
|
|
|
- "functionId": 1,
|
|
|
- "functionName": "工单查询",
|
|
|
- "systemName": "流程",
|
|
|
- "clientName": "所有",
|
|
|
- "priority": 0,
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "appIcon": "appIcon"
|
|
|
- },
|
|
|
- {
|
|
|
- "functionId": 2,
|
|
|
- "functionName": "工单答复",
|
|
|
- "systemName": "流程",
|
|
|
- "clientName": "app",
|
|
|
- "priority": 0,
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "appIcon": "appIcon"
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
-
|
|
|
-functionName: 功能名称
|
|
|
|
|
|
-client: 客户端,0:所有,1:app,2:web
|
|
|
-
|
|
|
-system: 系统
|
|
|
-
|
|
|
-current: 页码
|
|
|
+## 查询用户列表接口
|
|
|
|
|
|
-pageSize: 每页个数
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**接口地址**:`/api/web/user/list`
|
|
|
|
|
|
-total: 数据总数
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-functionName: 模块名称
|
|
|
|
|
|
-systemName: 系统中文名称
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-clientName: 客户端名称
|
|
|
|
|
|
-priority: 显示优先级
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-url: 模块链接
|
|
|
|
|
|
-webIcon: web图标链接
|
|
|
+**接口描述**:
|
|
|
|
|
|
-appIcon: app图标链接
|
|
|
|
|
|
-## 添加模块接口
|
|
|
+**请求示例**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/function/add
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+```javascript
|
|
|
{
|
|
|
- "functionName": "工单查询",
|
|
|
- "system": "flow",
|
|
|
- "client": 1,
|
|
|
- "priority": 0,
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "appIcon": "appIcon"
|
|
|
+ "current": 1,
|
|
|
+ "pageSize": 10,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "org": "河北",
|
|
|
+ "areaId": -1
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|listUserDto|ListUserDto|body|true|ListUserDto|ListUserDto|
|
|
|
+|  current|页码,最小值1||true|integer(int32)||
|
|
|
+|  pageSize|每页个数,最小值1||true|integer(int32)||
|
|
|
+|  loginName|账号||false|string||
|
|
|
+|  userName|用户名||false|string||
|
|
|
+|  org|组织||false|string||
|
|
|
+|  areaId|地区id||false|integer(int32)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RPageVoListUserVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||PageVoListUserVo|PageVoListUserVo|
|
|
|
+|  total|数据总条数|integer(int64)||
|
|
|
+|  list|数据列表|array|ListUserVo|
|
|
|
+|    userId|用户id|integer||
|
|
|
+|    loginName|账号|string||
|
|
|
+|    userName|用户名|string||
|
|
|
+|    phone|手机号|string||
|
|
|
+|    email|邮箱|string||
|
|
|
+|    org|河北省分公司云网运营中心|string||
|
|
|
+|    provinceName|省份名称|string||
|
|
|
+|    cityName|地市名称|string||
|
|
|
+|    areaName|区县名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "total": 1000,
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "userId": 0,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "phone": "12345678901",
|
|
|
+ "email": "",
|
|
|
+ "org": "",
|
|
|
+ "provinceName": "河北省",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "areaName": "长安区"
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-functionName: 功能名称
|
|
|
+## 查询top用户信息
|
|
|
+
|
|
|
|
|
|
-system: 系统
|
|
|
+**接口地址**:`/api/web/user/getTopUserByLoginName`
|
|
|
|
|
|
-client: 客户端,0:所有,1:app,2:web
|
|
|
|
|
|
-priority: 显示优先级
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-url: 模块链接
|
|
|
|
|
|
-webIcon: web图标链接
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-appIcon: app图标链接
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
|
|
|
-## 修改模块接口
|
|
|
+**接口描述**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/function/update
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "functionId": 1,
|
|
|
- "functionName": "工单查询",
|
|
|
- "system": "flow",
|
|
|
- "client": 1,
|
|
|
- "priority": 0,
|
|
|
- "url": "url",
|
|
|
- "webIcon": "webIcon",
|
|
|
- "appIcon": "appIcon"
|
|
|
+ "loginName": "zhangsan"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|topUserDto|TopUserDto|body|true|TopUserDto|TopUserDto|
|
|
|
+|  loginName|账号||true|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|default|default response|RTopUserVo|
|
|
|
+|没有查询到top用户信息|{"success":false,"code":0,"message":"没有查询到top用户信息","data":null}||
|
|
|
+|非本地市用户|{"success":false,"code":0,"message":"非本地市用户","data":null}||
|
|
|
+|用户已存在系统中|{"success":false,"code":0,"message":"用户已存在系统中","data":null}||
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||TopUserVo|TopUserVo|
|
|
|
+|  loginName|账号|string||
|
|
|
+|  userName|用户名|string||
|
|
|
+|  phone|手机号|string||
|
|
|
+|  orgName|组织|string||
|
|
|
+|  provinceId|省份id|integer(int32)||
|
|
|
+|  cityId|地市id|integer(int32)||
|
|
|
+|  areaId|区县id|integer(int32)||
|
|
|
+|  provinceName|省份名称|string||
|
|
|
+|  cityName|地市名称|string||
|
|
|
+|  areaName|区县名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "phone": "12345678901",
|
|
|
+ "orgName": "河北省分公司云网运营中心",
|
|
|
+ "provinceId": 0,
|
|
|
+ "cityId": 0,
|
|
|
+ "areaId": 0,
|
|
|
+ "provinceName": "河北省",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "areaName": "长安区"
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+## 查询用户权限
|
|
|
+
|
|
|
|
|
|
-functionName: 功能名称
|
|
|
+**接口地址**:`/api/web/user/getRoleByLoginName`
|
|
|
|
|
|
-system: 系统
|
|
|
|
|
|
-client: 客户端,0:所有,1:app,2:web
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-priority: 显示优先级
|
|
|
|
|
|
-url: 模块链接
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-webIcon: web图标链接
|
|
|
|
|
|
-appIcon: app图标链接
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
+**接口描述**:
|
|
|
|
|
|
-## 删除模块接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/function/del
|
|
|
-Content-Type: application/json
|
|
|
+**请求示例**:
|
|
|
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "functionId": 1
|
|
|
+ "loginName": "zhangsan"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|getRoleByLoginNameDto|GetRoleByLoginNameDto|body|true|GetRoleByLoginNameDto|GetRoleByLoginNameDto|
|
|
|
+|  loginName|账号||true|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|用户不存在|{"success":false,"code":0,"message":"用户不存在","data":null}||
|
|
|
+|default|default response|RListGetRoleByLoginNameVo|
|
|
|
+|非本地市用户|{"success":false,"code":0,"message":"非本地市用户","data":null}||
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|array|GetRoleByLoginNameVo|
|
|
|
+|  roleId|角色id|integer(int32)||
|
|
|
+|  roleName|角色名称|string||
|
|
|
+|  system|系统id|string||
|
|
|
+|  systemName|系统名称|string||
|
|
|
+|  cityId|地区id|integer(int32)||
|
|
|
+|  cityName|地市名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "roleId": 0,
|
|
|
+ "roleName": "工单查询",
|
|
|
+ "system": "flow",
|
|
|
+ "systemName": "流程",
|
|
|
+ "cityId": 0,
|
|
|
+ "cityName": "石家庄市"
|
|
|
+ }
|
|
|
+ ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+## 查询用户详情
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/user/detail`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-## 查询top用户信息接口
|
|
|
+**接口描述**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/getTopUserByLoginName
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "loginName": "zhangsan"
|
|
|
+ "userId": 0
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|getUserDetailDto|GetUserDetailDto|body|true|GetUserDetailDto|GetUserDetailDto|
|
|
|
+|  userId|用户id||true|integer(int32)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RGetUserDetailVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||GetUserDetailVo|GetUserDetailVo|
|
|
|
+|  userId|用户id|integer(int32)||
|
|
|
+|  loginName|账号|string||
|
|
|
+|  userName|用户名|string||
|
|
|
+|  phone|手机号|string||
|
|
|
+|  orgName|组织|string||
|
|
|
+|  provinceName|省份名称|string||
|
|
|
+|  cityName|地市名称|string||
|
|
|
+|  areaName|区县名称|string||
|
|
|
+|  email|邮箱|string||
|
|
|
+|  roles|角色列表|array|GetUserDetailRoleVo|
|
|
|
+|    roleId|角色id|integer||
|
|
|
+|    cityId|地区id|integer||
|
|
|
+|    roleName|角色名称|string||
|
|
|
+|    cityName|地市名称|string||
|
|
|
+|    system|系统id|string||
|
|
|
+|    systemName|系统名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "userId": 7,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "phone": "12345678909",
|
|
|
- "org": "河北省分公司云网运营中心",
|
|
|
- "provinceId": -1,
|
|
|
- "cityId": 130300,
|
|
|
- "areaId": 130302,
|
|
|
- "provinceName": "河北省",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "areaName": "长安区"
|
|
|
- }
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "userId": 0,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "phone": "12345678901",
|
|
|
+ "orgName": "河北省分公司云网运营中心",
|
|
|
+ "provinceName": "河北省",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "areaName": "长安区",
|
|
|
+ "email": "",
|
|
|
+ "roles": [
|
|
|
+ {
|
|
|
+ "roleId": 0,
|
|
|
+ "cityId": 0,
|
|
|
+ "roleName": "工单查询",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "system": "flow",
|
|
|
+ "systemName": "流程"
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-loginName: 账号
|
|
|
+## 删除用户
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-userId: 用户id
|
|
|
+**接口地址**:`/api/web/user/del`
|
|
|
|
|
|
-loginName: 账号
|
|
|
|
|
|
-phone: 手机号
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-org: 组织
|
|
|
|
|
|
-provinceId: 省份id
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-cityId: 地市id
|
|
|
|
|
|
-areaId: 区县id
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-provinceName: 省份名称
|
|
|
|
|
|
-cityName: 地市名称
|
|
|
+**接口描述**:
|
|
|
|
|
|
-areaName: 区县名称
|
|
|
|
|
|
-### 特殊情况
|
|
|
+**请求示例**:
|
|
|
|
|
|
-- 用户已存在
|
|
|
|
|
|
-```json
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": false,
|
|
|
- "code": 0,
|
|
|
- "message": "用户已存在",
|
|
|
- "data": null
|
|
|
+ "userIds": []
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-- top用户不存在
|
|
|
|
|
|
-```json
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|deleteUserDto|DeleteUserDto|body|true|DeleteUserDto|DeleteUserDto|
|
|
|
+|  userIds|用户id列表||true|array|integer(int32)|
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|无法删除非本地市用户|{"success":false,"code":0,"message":"无法删除非本地市用户","data":null}||
|
|
|
+|default|default response|RObject|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|object||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": false,
|
|
|
- "code": 0,
|
|
|
- "message": "top用户不存在",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-## 查询所有权限列表接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/role/all
|
|
|
-Content-Type: application/json
|
|
|
+## 批量复制权限
|
|
|
|
|
|
-{}
|
|
|
-```
|
|
|
|
|
|
-```json
|
|
|
+**接口地址**:`/api/web/user/copyRole`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
+
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
+
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
+ "userIds": [],
|
|
|
+ "roles": [
|
|
|
{
|
|
|
- "roleId": 42,
|
|
|
+ "roleId": 0,
|
|
|
+ "cityId": 0,
|
|
|
"roleName": "工单查询",
|
|
|
- "functionId": 1,
|
|
|
- "system": "flow",
|
|
|
- "systemName": "流程"
|
|
|
- },
|
|
|
- {
|
|
|
- "roleId": 43,
|
|
|
- "roleName": "工单答复",
|
|
|
- "functionId": 2,
|
|
|
- "system": "flow",
|
|
|
- "systemName": "流程"
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "functionId": 0
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-roleId: 角色id
|
|
|
+**请求参数**:
|
|
|
|
|
|
-roleName: 角色名称
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|copyRolesDto|CopyRolesDto|body|true|CopyRolesDto|CopyRolesDto|
|
|
|
+|  userIds|用户id列表||true|array|integer(int32)|
|
|
|
+|  roles|角色列表||true|array|AddUserRoleDto|
|
|
|
+|    roleId|角色id||true|integer||
|
|
|
+|    cityId|地市id||true|integer||
|
|
|
+|    roleName|角色名称||true|string||
|
|
|
+|    cityName|地市名称||true|string||
|
|
|
+|    functionId|功能id||false|integer||
|
|
|
|
|
|
-system: 系统
|
|
|
|
|
|
-systemName: 系统中文名称
|
|
|
+**响应状态**:
|
|
|
|
|
|
-## 查询地市列表接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/area/listCity
|
|
|
-Content-Type: application/json
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|default|default response|RObject|
|
|
|
+|无法修改非本地市用户|{"success":false,"code":0,"message":"无法修改非本地市用户","data":null}||
|
|
|
|
|
|
-{}
|
|
|
-```
|
|
|
|
|
|
-```json
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|object||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
- {
|
|
|
- "areaId": 130100,
|
|
|
- "areaName": "石家庄市"
|
|
|
- },
|
|
|
- {
|
|
|
- "areaId": 130200,
|
|
|
- "areaName": "唐山市"
|
|
|
- }
|
|
|
- ]
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-areaId: 地市id
|
|
|
+## 添加用户
|
|
|
|
|
|
-areaName: 地市名称
|
|
|
|
|
|
-## 查询省市区树形接口
|
|
|
+**接口地址**:`/api/web/user/add`
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/area/treeArea
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
-{}
|
|
|
-```
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
|
|
|
-```json
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
+
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
+
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "email": "",
|
|
|
+ "roles": [
|
|
|
{
|
|
|
- "label": "河北省",
|
|
|
- "value": -1,
|
|
|
- "children": [
|
|
|
- {
|
|
|
- "label": "石家庄市",
|
|
|
- "value": 130100,
|
|
|
- "children": [
|
|
|
- {
|
|
|
- "label": "长安区",
|
|
|
- "value": 130102
|
|
|
- },
|
|
|
- {
|
|
|
- "label": "桥西区",
|
|
|
- "value": 130104
|
|
|
- }
|
|
|
- ]
|
|
|
- },
|
|
|
- {
|
|
|
- "label": "唐山市",
|
|
|
- "value": 130100,
|
|
|
- "children": [
|
|
|
- {
|
|
|
- "label": "长安区",
|
|
|
- "value": 130102
|
|
|
- },
|
|
|
- {
|
|
|
- "label": "桥西区",
|
|
|
- "value": 130104
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
- ]
|
|
|
+ "roleId": 0,
|
|
|
+ "cityId": 0,
|
|
|
+ "roleName": "工单查询",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "functionId": 0
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-value: 省市区id
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|addUserDto|AddUserDto|body|true|AddUserDto|AddUserDto|
|
|
|
+|  loginName|账号||true|string||
|
|
|
+|  email|邮箱||false|string||
|
|
|
+|  roles|角色列表||false|array|AddUserRoleDto|
|
|
|
+|    roleId|角色id||true|integer||
|
|
|
+|    cityId|地市id||true|integer||
|
|
|
+|    roleName|角色名称||true|string||
|
|
|
+|    cityName|地市名称||true|string||
|
|
|
+|    functionId|功能id||false|integer||
|
|
|
+
|
|
|
|
|
|
-label: 省市区名称
|
|
|
+**响应状态**:
|
|
|
|
|
|
-children: 地市或区县列表
|
|
|
|
|
|
-## 查询用户权限接口
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|无法添加非本地市用户|{"success":false,"code":0,"message":"无法添加非本地市用户","data":null}||
|
|
|
+|default|default response|RObject|
|
|
|
+|用户已存在系统中|{"success":false,"code":0,"message":"用户已存在系统中","data":null}||
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/getRoleByLoginName
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|object||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "loginName": "zhangsan"
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+# 系统
|
|
|
+
|
|
|
+
|
|
|
+## 查询系统列表
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/system/list`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
+
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+暂无
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RListAclSystem|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|array|AclSystem|
|
|
|
+|  system|系统id|string||
|
|
|
+|  systemName|系统名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300
|
|
|
- },
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300
|
|
|
- }
|
|
|
- ]
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "system": "flow",
|
|
|
+ "systemName": "流程"
|
|
|
+ }
|
|
|
+ ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-loginName: 账号
|
|
|
+# 角色
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-roleId: 角色id
|
|
|
+## 查询角色说明列表
|
|
|
|
|
|
-cityId: 地市id
|
|
|
|
|
|
-## 查询用户列表接口
|
|
|
+**接口地址**:`/api/web/role/list`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
+
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/list
|
|
|
-Content-Type: application/json
|
|
|
+**请求示例**:
|
|
|
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "current": 1,
|
|
|
- "pageSize": 10,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "org": "河北省分公司云网运营中心",
|
|
|
- "areaId": 130302
|
|
|
+ "current": 1,
|
|
|
+ "pageSize": 10,
|
|
|
+ "roleName": "工单",
|
|
|
+ "system": "flow"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|listRoleDto|ListRoleDto|body|true|ListRoleDto|ListRoleDto|
|
|
|
+|  current|页码,最小值1||true|integer(int32)||
|
|
|
+|  pageSize|每页个数,最小值1||true|integer(int32)||
|
|
|
+|  roleName|角色名称||false|string||
|
|
|
+|  system|系统id||false|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RPageVoListRoleVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||PageVoListRoleVo|PageVoListRoleVo|
|
|
|
+|  total|数据总条数|integer(int64)||
|
|
|
+|  list|数据列表|array|ListRoleVo|
|
|
|
+|    roleName|角色名称|string||
|
|
|
+|    system|系统id|string||
|
|
|
+|    systemName|系统名称|string||
|
|
|
+|    roleDescription|角色说明|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "total": 100,
|
|
|
- "list": [
|
|
|
- {
|
|
|
- "userId": 1,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "phone": "12345678909",
|
|
|
- "email": "a@qq.com",
|
|
|
- "org": "河北省分公司云网运营中心",
|
|
|
- "provinceName": "河北省",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "areaName": "长安区"
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "total": 1000,
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "roleName": "工单查询",
|
|
|
+ "system": "flow",
|
|
|
+ "systemName": "流程",
|
|
|
+ "roleDescription": ""
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-loginName: 账号
|
|
|
+## 查询所有角色
|
|
|
|
|
|
-userName: 用户名
|
|
|
|
|
|
-org: 组织
|
|
|
+**接口地址**:`/api/web/role/all`
|
|
|
|
|
|
-areaId: 省市区id
|
|
|
|
|
|
-current: 页码
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-pageSize: 每页个数
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded`
|
|
|
|
|
|
-total: 数据总数
|
|
|
|
|
|
-userId: 用户id
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-loginName: 账号
|
|
|
|
|
|
-userName: 用户名
|
|
|
+**接口描述**:
|
|
|
|
|
|
-phone: 手机号
|
|
|
|
|
|
-email: 邮箱
|
|
|
+**请求参数**:
|
|
|
|
|
|
-org: 组织
|
|
|
|
|
|
-provinceName: 省份名称
|
|
|
+暂无
|
|
|
|
|
|
-cityName: 地市名称
|
|
|
|
|
|
-areaName: 区县名称
|
|
|
+**响应状态**:
|
|
|
|
|
|
-## 添加用户接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/add
|
|
|
-Content-Type: application/json
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RListAllRoleVo|
|
|
|
|
|
|
-{
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "phone": "12345678909",
|
|
|
- "email": "a@qq.com",
|
|
|
- "org": "河北省分公司云网运营中心",
|
|
|
- "provinceId": -1,
|
|
|
- "cityId": 130300,
|
|
|
- "areaId": 130302,
|
|
|
- "roles": [
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- },
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- }
|
|
|
- ]
|
|
|
-}
|
|
|
-```
|
|
|
|
|
|
-```json
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data|数据|array|AllRoleVo|
|
|
|
+|  roleId|角色id|integer(int32)||
|
|
|
+|  functionId|功能id|integer(int32)||
|
|
|
+|  roleName|角色名称|string||
|
|
|
+|  system|系统id|string||
|
|
|
+|  systemName|系统名称|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "roleId": 0,
|
|
|
+ "functionId": 0,
|
|
|
+ "roleName": "工单查询",
|
|
|
+ "system": "flow",
|
|
|
+ "systemName": "流程"
|
|
|
+ }
|
|
|
+ ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-loginName: 账号
|
|
|
+# 日志
|
|
|
+
|
|
|
|
|
|
-userName: 用户名
|
|
|
+## 查询登录日志列表
|
|
|
|
|
|
-phone: 手机号
|
|
|
|
|
|
-email: 邮箱
|
|
|
+**接口地址**:`/api/web/log/verificationLog/list`
|
|
|
|
|
|
-org: 组织
|
|
|
|
|
|
-provinceId: 省份id
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-cityId: 地市id
|
|
|
|
|
|
-areaId: 区县id
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-roleId: 角色id
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**接口描述**:
|
|
|
|
|
|
-### 特殊情况
|
|
|
|
|
|
-- 用户已存在
|
|
|
+**请求示例**:
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": false,
|
|
|
- "code": 0,
|
|
|
- "message": "用户已存在",
|
|
|
- "data": null
|
|
|
+ "current": 1,
|
|
|
+ "pageSize": 10,
|
|
|
+ "userId": 0,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "startTime": "",
|
|
|
+ "endTime": "",
|
|
|
+ "system": "flow",
|
|
|
+ "cityId": 0
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-- top用户不存在
|
|
|
|
|
|
-```json
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|listVerificationLogDto|ListVerificationLogDto|body|true|ListVerificationLogDto|ListVerificationLogDto|
|
|
|
+|  current|页码,最小值1||true|integer(int32)||
|
|
|
+|  pageSize|每页个数,最小值1||true|integer(int32)||
|
|
|
+|  userId|用户id||false|integer(int32)||
|
|
|
+|  loginName|账号||false|string||
|
|
|
+|  userName|用户名||false|string||
|
|
|
+|  startTime|起始时间||false|string(date-time)||
|
|
|
+|  endTime|截至时间||false|string(date-time)||
|
|
|
+|  system|系统id||false|string||
|
|
|
+|  cityId|地区id||false|integer(int32)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RPageVoListVerificationLogVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||PageVoListVerificationLogVo|PageVoListVerificationLogVo|
|
|
|
+|  total|数据总条数|integer(int64)||
|
|
|
+|  list|数据列表|array|ListVerificationLogVo|
|
|
|
+|    userId|用户id|integer||
|
|
|
+|    loginName|账号|string||
|
|
|
+|    userName|用户名|string||
|
|
|
+|    cityName|地市名称|string||
|
|
|
+|    systemName|系统名称|string||
|
|
|
+|    loginTime||string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": false,
|
|
|
- "code": 0,
|
|
|
- "message": "top用户不存在",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "total": 1000,
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "userId": 0,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "cityName": "石家庄市",
|
|
|
+ "systemName": "流程",
|
|
|
+ "loginTime": ""
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-## 修改用户接口
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/update
|
|
|
-Content-Type: application/json
|
|
|
+## 导出登录日志
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/log/verificationLog/export`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
+
|
|
|
+**请求示例**:
|
|
|
+
|
|
|
+
|
|
|
+```javascript
|
|
|
{
|
|
|
- "userId": 1,
|
|
|
- "email": "a@qq.com",
|
|
|
- "roles": [
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- },
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- }
|
|
|
- ]
|
|
|
+ "userId": 0,
|
|
|
+ "loginName": "zhangsan",
|
|
|
+ "userName": "张三",
|
|
|
+ "operationName": "修改用户",
|
|
|
+ "startTime": "",
|
|
|
+ "endTime": "",
|
|
|
+ "system": "flow",
|
|
|
+ "cityId": 0
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|exportVerificationLogDto|ExportVerificationLogDto|body|true|ExportVerificationLogDto|ExportVerificationLogDto|
|
|
|
+|  userId|用户id||false|integer(int32)||
|
|
|
+|  loginName|账号||false|string||
|
|
|
+|  userName|用户名||false|string||
|
|
|
+|  operationName|操作名称||false|string||
|
|
|
+|  startTime|||false|string(date-time)||
|
|
|
+|  endTime|||false|string(date-time)||
|
|
|
+|  system|系统id||false|string||
|
|
|
+|  cityId|地区id||false|integer(int32)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RExportVerificationLogVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||ExportVerificationLogVo|ExportVerificationLogVo|
|
|
|
+|  url|导出文件链接|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "url": ""
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
-### 输入参数说明
|
|
|
+## 查询操作日志列表
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/log/operationLog/list`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
|
|
|
-userId: 用户id
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-email: 邮箱
|
|
|
|
|
|
-cityId: 地市id
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-roleId: 角色id
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+**接口描述**:
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-## 删除用户接口
|
|
|
+**请求示例**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/del
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+```javascript
|
|
|
{
|
|
|
- "userId": 1
|
|
|
+ "current": 1,
|
|
|
+ "pageSize": 10,
|
|
|
+ "operatorId": 0,
|
|
|
+ "operatorAccount": "zhangsan",
|
|
|
+ "operatorName": "张三",
|
|
|
+ "operationName": "修改用户",
|
|
|
+ "startTime": "",
|
|
|
+ "endTime": ""
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|listOperationLogDto|ListOperationLogDto|body|true|ListOperationLogDto|ListOperationLogDto|
|
|
|
+|  current|页码,最小值1||true|integer(int32)||
|
|
|
+|  pageSize|每页个数,最小值1||true|integer(int32)||
|
|
|
+|  operatorId|用户id||false|integer(int32)||
|
|
|
+|  operatorAccount|账号||false|string||
|
|
|
+|  operatorName|用户名||false|string||
|
|
|
+|  operationName|操作名称||false|string||
|
|
|
+|  startTime|起始时间||false|string(date-time)||
|
|
|
+|  endTime|截至时间||false|string(date-time)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RPageVoListOperationLogVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||PageVoListOperationLogVo|PageVoListOperationLogVo|
|
|
|
+|  total|数据总条数|integer(int64)||
|
|
|
+|  list|数据列表|array|ListOperationLogVo|
|
|
|
+|    operatorId|用户id|integer||
|
|
|
+|    operatorAccount|账号|string||
|
|
|
+|    operatorName|用户名|string||
|
|
|
+|    operationName|操作名称|string||
|
|
|
+|    operationContent|操作内容|string||
|
|
|
+|    operationTime||string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "total": 1000,
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "operatorId": 0,
|
|
|
+ "operatorAccount": "zhangsan",
|
|
|
+ "operatorName": "张三",
|
|
|
+ "operationName": "修改用户",
|
|
|
+ "operationContent": "",
|
|
|
+ "operationTime": ""
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
-### 输入参数说明
|
|
|
+## 导出操作日志
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/log/operationLog/export`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
|
|
|
-userId: 用户id
|
|
|
+**接口描述**:
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-## 查询用户详情接口
|
|
|
+**请求示例**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/user/detail
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+```javascript
|
|
|
{
|
|
|
- "userId": 1
|
|
|
+ "operatorId": 0,
|
|
|
+ "operatorAccount": "zhangsan",
|
|
|
+ "operatorName": "张三",
|
|
|
+ "operationName": "修改用户",
|
|
|
+ "startTime": "",
|
|
|
+ "endTime": ""
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|exportOperationLogDto|ExportOperationLogDto|body|true|ExportOperationLogDto|ExportOperationLogDto|
|
|
|
+|  operatorId|用户id||false|integer(int32)||
|
|
|
+|  operatorAccount|账号||false|string||
|
|
|
+|  operatorName|用户名||false|string||
|
|
|
+|  operationName|操作名称||false|string||
|
|
|
+|  startTime|||false|string(date-time)||
|
|
|
+|  endTime|||false|string(date-time)||
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RExportOperationLogVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||ExportOperationLogVo|ExportOperationLogVo|
|
|
|
+|  url|导出文件链接|string||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": [
|
|
|
- {
|
|
|
- "userId": 1,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "phone": "12345678909",
|
|
|
- "email": "a@qq.com",
|
|
|
- "org": "河北省分公司云网运营中心",
|
|
|
- "provinceName": "河北省",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "areaName": "长安区",
|
|
|
- "roles": [
|
|
|
- {
|
|
|
- "roleName": "工单查询",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "system": "liucheng",
|
|
|
- "systemName": "流程"
|
|
|
- },
|
|
|
- {
|
|
|
- "roleName": "黑点库查询",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "system": "heidianku",
|
|
|
- "systemName": "黑点库"
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
- ]
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "url": ""
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-userId: 用户id
|
|
|
+# 功能
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-userId: 用户id
|
|
|
+## 查询模块列表
|
|
|
|
|
|
-loginName: 账号
|
|
|
|
|
|
-userName: 用户名
|
|
|
+**接口地址**:`/api/web/function/list`
|
|
|
|
|
|
-phone: 手机号
|
|
|
|
|
|
-email: 邮箱
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-org: 组织
|
|
|
|
|
|
-provinceName: 省份名称
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
|
|
|
-cityName: 地市名称
|
|
|
|
|
|
-areaName: 区县名称
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-roleName: 角色名称
|
|
|
|
|
|
-cityName: 地市名称
|
|
|
+**接口描述**:
|
|
|
|
|
|
-system: 系统
|
|
|
|
|
|
-systemName: 系统中文名称
|
|
|
+**请求示例**:
|
|
|
|
|
|
-## 批量复制权限接口
|
|
|
-
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/role/copy
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+```javascript
|
|
|
{
|
|
|
- "userIds": [1, 2],
|
|
|
- "roles": [
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- },
|
|
|
- {
|
|
|
- "roleId": 42,
|
|
|
- "cityId": 130300,
|
|
|
- "functionId": 1
|
|
|
- }
|
|
|
- ]
|
|
|
+ "current": 1,
|
|
|
+ "pageSize": 10,
|
|
|
+ "functionName": "工单",
|
|
|
+ "client": 0,
|
|
|
+ "system": "flow"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
-{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": null
|
|
|
-}
|
|
|
-```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
+**请求参数**:
|
|
|
|
|
|
-userIds: 用户id列表
|
|
|
|
|
|
-cityId: 地市id
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|listFunctionDto|ListFunctionDto|body|true|ListFunctionDto|ListFunctionDto|
|
|
|
+|  current|页码,最小值1||true|integer(int32)||
|
|
|
+|  pageSize|每页个数,最小值1||true|integer(int32)||
|
|
|
+|  functionName|模块名称||false|string||
|
|
|
+|  client|客户端id||false|integer(int32)||
|
|
|
+|  system|系统id||false|string||
|
|
|
|
|
|
-roleId: 角色id
|
|
|
|
|
|
-functionId: 模块id
|
|
|
+**响应状态**:
|
|
|
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RPageVoListFunctionVo|
|
|
|
|
|
|
|
|
|
-## 查询操作日志列表接口
|
|
|
+**响应参数**:
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/log/operationLog
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
-{
|
|
|
- "current": 1,
|
|
|
- "pageSize": 10,
|
|
|
- "operatorId": 1,
|
|
|
- "operatorAccount": "zhangsan",
|
|
|
- "operatorName": "张三",
|
|
|
- "operationName": "修改用户",
|
|
|
- "operationContent": "操作内容",
|
|
|
- "startTime": "2022-11-01 13:00:00",
|
|
|
- "endTime": "2022-11-01 13:00:00"
|
|
|
-}
|
|
|
-```
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||PageVoListFunctionVo|PageVoListFunctionVo|
|
|
|
+|  total|数据总条数|integer(int64)||
|
|
|
+|  list|数据列表|array|ListFunctionVo|
|
|
|
+|    functionId|模块id|integer||
|
|
|
+|    functionName|模块名称|string||
|
|
|
+|    systemName|系统名称|string||
|
|
|
+|    clientName|客户端名称|string||
|
|
|
+|    functionDescription|模块描述|string||
|
|
|
+|    appPriority|app显示优先级|integer||
|
|
|
+|    webPriority|web显示优先级|integer||
|
|
|
+|    webUrl|web链接|string||
|
|
|
+|    appUrl|app链接|string||
|
|
|
+|    webIcon|web图标|string||
|
|
|
+|    appIcon|app图标|string||
|
|
|
+
|
|
|
|
|
|
-```json
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "total": 100,
|
|
|
- "list": [
|
|
|
- {
|
|
|
- "operatorId": 1,
|
|
|
- "operatorAccount": "zhangsan",
|
|
|
- "operatorName": "张三",
|
|
|
- "operationName": "修改用户",
|
|
|
- "operationContent": "操作内容",
|
|
|
- "operationTime": "2022-11-01 13:00:00"
|
|
|
- },
|
|
|
- {
|
|
|
- "operatorId": 1,
|
|
|
- "operatorAccount": "zhangsan",
|
|
|
- "operatorName": "张三",
|
|
|
- "operationName": "修改用户",
|
|
|
- "operationContent": "操作内容",
|
|
|
- "operationTime": "2022-11-01 13:00:00"
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "total": 1000,
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "functionId": 0,
|
|
|
+ "functionName": "工单查询",
|
|
|
+ "systemName": "流程",
|
|
|
+ "clientName": "app",
|
|
|
+ "functionDescription": "",
|
|
|
+ "appPriority": 0,
|
|
|
+ "webPriority": 0,
|
|
|
+ "webUrl": "",
|
|
|
+ "appUrl": "",
|
|
|
+ "webIcon": "",
|
|
|
+ "appIcon": ""
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-operatorId: 操作人id
|
|
|
+# 地区
|
|
|
+
|
|
|
+
|
|
|
+## 查询省市区树形接口(用户列表地区选择框)
|
|
|
+
|
|
|
|
|
|
-operatorAccount: 操作人账号
|
|
|
+**接口地址**:`/api/web/area/tree`
|
|
|
|
|
|
-operatorName: 操作人姓名
|
|
|
|
|
|
-operationName: 操作名称
|
|
|
+**请求方式**:`POST`
|
|
|
|
|
|
-operationContent: 操作内容
|
|
|
|
|
|
-startTime: 起始时间
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded`
|
|
|
|
|
|
-endTime: 截至时间
|
|
|
|
|
|
-current: 页码
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-pageSize: 每页个数
|
|
|
|
|
|
-### 输出参数说明
|
|
|
+**接口描述**:
|
|
|
|
|
|
-total: 数据总数
|
|
|
|
|
|
-operatorId: 操作人id
|
|
|
+**请求参数**:
|
|
|
|
|
|
-operatorAccount: 操作人账号
|
|
|
|
|
|
-operatorName: 操作人姓名
|
|
|
+暂无
|
|
|
|
|
|
-operationName: 操作名称
|
|
|
|
|
|
-operationContent: 操作内容
|
|
|
+**响应状态**:
|
|
|
|
|
|
-operationTime: 操作时间
|
|
|
|
|
|
-## 查询登录日志列表接口
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RTreeAreaVo|
|
|
|
|
|
|
-```http
|
|
|
-POST HTTP://127.0.0.1:12128/rest/api/log/verificationLog
|
|
|
-Content-Type: application/json
|
|
|
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||TreeAreaVo|TreeAreaVo|
|
|
|
+|  label|地区名称|string||
|
|
|
+|  value|地区id|integer(int32)||
|
|
|
+|  children|子地区列表|array|TreeAreaVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "current": 1,
|
|
|
- "pageSize": 10,
|
|
|
- "userId": 1,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "system": "liucheng",
|
|
|
- "cityId": 130300,
|
|
|
- "startTime": "2022-11-25T16:30:15.160",
|
|
|
- "endTime": "2022-11-25T16:30:15.160"
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "label": "河北省",
|
|
|
+ "value": -1,
|
|
|
+ "children": [
|
|
|
+ {
|
|
|
+ "label": "河北省",
|
|
|
+ "value": -1,
|
|
|
+ "children": [
|
|
|
+ {}
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-```json
|
|
|
+
|
|
|
+## 查询省和地市树形接口(添加修改用户、操作日志地区选择框)
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/web/area/treeProvinceCity`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded`
|
|
|
+
|
|
|
+
|
|
|
+**响应数据类型**:`*/*`
|
|
|
+
|
|
|
+
|
|
|
+**接口描述**:
|
|
|
+
|
|
|
+
|
|
|
+**请求参数**:
|
|
|
+
|
|
|
+
|
|
|
+暂无
|
|
|
+
|
|
|
+
|
|
|
+**响应状态**:
|
|
|
+
|
|
|
+
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|200|OK|RTreeAreaVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应参数**:
|
|
|
+
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|success|是否成功|boolean||
|
|
|
+|code|业务码|integer(int32)|integer(int32)|
|
|
|
+|message|提示信息|string||
|
|
|
+|data||TreeAreaVo|TreeAreaVo|
|
|
|
+|  label|地区名称|string||
|
|
|
+|  value|地区id|integer(int32)||
|
|
|
+|  children|子地区列表|array|TreeAreaVo|
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
{
|
|
|
- "success": true,
|
|
|
- "code": 1,
|
|
|
- "message": "成功",
|
|
|
- "data": {
|
|
|
- "total": 100,
|
|
|
- "list": [
|
|
|
- {
|
|
|
- "userId": 1,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "systemName": "流程",
|
|
|
- "loginTime": "2022-11-01 13:00:00"
|
|
|
- },
|
|
|
- {
|
|
|
- "userId": 1,
|
|
|
- "loginName": "zhangsan",
|
|
|
- "userName": "张三",
|
|
|
- "cityName": "石家庄市",
|
|
|
- "systemName": "流程",
|
|
|
- "loginTime": "2022-11-01 13:00:00"
|
|
|
- }
|
|
|
- ]
|
|
|
- }
|
|
|
+ "success": true,
|
|
|
+ "code": 0,
|
|
|
+ "message": "成功",
|
|
|
+ "data": {
|
|
|
+ "label": "河北省",
|
|
|
+ "value": -1,
|
|
|
+ "children": [
|
|
|
+ {
|
|
|
+ "label": "河北省",
|
|
|
+ "value": -1,
|
|
|
+ "children": [
|
|
|
+ {}
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 输入参数说明
|
|
|
|
|
|
-userId: 用户id
|
|
|
+# 鉴权
|
|
|
+
|
|
|
+
|
|
|
+## 鉴权
|
|
|
+
|
|
|
+
|
|
|
+**接口地址**:`/api/verification`
|
|
|
+
|
|
|
+
|
|
|
+**请求方式**:`POST`
|
|
|
+
|
|
|
+
|
|
|
+**请求数据类型**:`application/x-www-form-urlencoded,application/json`
|
|
|
+
|
|
|
|
|
|
-loginName: 账号
|
|
|
+**响应数据类型**:`*/*`
|
|
|
|
|
|
-userName: 用户名
|
|
|
|
|
|
-system: 系统
|
|
|
+**接口描述**:
|
|
|
|
|
|
-cityId: 地市id
|
|
|
|
|
|
-startTime: 起始时间
|
|
|
+**请求示例**:
|
|
|
|
|
|
-endTime: 截至时间
|
|
|
|
|
|
-current: 页码
|
|
|
+```javascript
|
|
|
+{
|
|
|
+ "token": "test_token_hebei",
|
|
|
+ "system": "web",
|
|
|
+ "fromSystem": "test"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
|
|
|
-pageSize: 每页个数
|
|
|
+**请求参数**:
|
|
|
|
|
|
-### 输出参数说明
|
|
|
|
|
|
-total: 数据总数
|
|
|
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|
|
|
+| -------- | -------- | ----- | -------- | -------- | ------ |
|
|
|
+|tokenVo|TokenVo|body|true|TokenVo|TokenVo|
|
|
|
+|  token|token||true|string||
|
|
|
+|  system|system||true|string||
|
|
|
+|  fromSystem|fromSystem||true|string||
|
|
|
|
|
|
-userId: 用户id
|
|
|
|
|
|
-loginName: 账号
|
|
|
+**响应状态**:
|
|
|
|
|
|
-userName: 用户名
|
|
|
|
|
|
-cityName: 地市名称
|
|
|
+| 状态码 | 说明 | schema |
|
|
|
+| -------- | -------- | ----- |
|
|
|
+|用户不存在|{"success":false,"code":0,"message":"用户不存在","data":null}||
|
|
|
+|app|{"success":true,"code":1,"message":"成功","data":{"userName":"张三","list":[{"id":1,"name":"工单处理","url":"url","webIcon":"webIcon","priority":0},{"id":2,"name":"工单答复","url":"url","webIcon":"webIcon","priority":0}]}}|WebVerificationVo|
|
|
|
|
|
|
-systemName: 系统中文名称
|
|
|
|
|
|
-loginTime: 登录时间
|
|
|
+**响应参数**:
|
|
|
|
|
|
+
|
|
|
+| 参数名称 | 参数说明 | 类型 | schema |
|
|
|
+| -------- | -------- | ----- |----- |
|
|
|
+|userName|用户名|string||
|
|
|
+|list|入口列表|array|WebFunctionVo|
|
|
|
+|  id|功能id|integer(int32)||
|
|
|
+|  name|功能名称|string||
|
|
|
+|  url|web链接|string||
|
|
|
+|  webIcon|web图标|string||
|
|
|
+|  priority|显示优先级|integer(int32)||
|
|
|
+
|
|
|
+
|
|
|
+**响应示例**:
|
|
|
+```javascript
|
|
|
+{
|
|
|
+ "userName": "张三",
|
|
|
+ "list": [
|
|
|
+ {
|
|
|
+ "id": 0,
|
|
|
+ "name": "",
|
|
|
+ "url": "",
|
|
|
+ "webIcon": "",
|
|
|
+ "priority": 0
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|