测试环境: http://192.168.50.3:12128
正式环境: http://192.168.70.125:12128
[TOC]
接口地址:/api/web/user/update
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"email": "",
"userId": 0,
"roles": [
{
"roleId": 0,
"cityId": 0,
"roleName": "工单查询",
"cityName": "石家庄市",
"functionId": 0
}
]
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| updateUserDto | UpdateUserDto | body | true | UpdateUserDto | UpdateUserDto |
| 邮箱 | 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 |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| default | default response | RObject |
| 无法修改非本地市用户 | {"success":false,"code":0,"message":"无法修改非本地市用户","data":null} |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| success | 是否成功 | boolean | |
| code | 业务码 | integer(int32) | integer(int32) |
| message | 提示信息 | string | |
| data | 数据 | object |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {}
}
接口地址:/api/web/user/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"current": 1,
"pageSize": 10,
"loginName": "zhangsan",
"userName": "张三",
"org": "河北",
"areaId": -1
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | |
| 邮箱 | string | ||
| org | 河北省分公司云网运营中心 | string | |
| provinceName | 省份名称 | string | |
| cityName | 地市名称 | string | |
| areaName | 区县名称 | string |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"total": 1000,
"list": [
{
"userId": 0,
"loginName": "zhangsan",
"userName": "张三",
"phone": "12345678901",
"email": "",
"org": "",
"provinceName": "河北省",
"cityName": "石家庄市",
"areaName": "长安区"
}
]
}
}
接口地址:/api/web/user/getTopUserByLoginName
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"loginName": "zhangsan"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"loginName": "zhangsan",
"userName": "张三",
"phone": "12345678901",
"orgName": "河北省分公司云网运营中心",
"provinceId": 0,
"cityId": 0,
"areaId": 0,
"provinceName": "河北省",
"cityName": "石家庄市",
"areaName": "长安区"
}
}
接口地址:/api/web/user/getRoleByLoginName
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"loginName": "zhangsan"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": [
{
"roleId": 0,
"roleName": "工单查询",
"system": "flow",
"systemName": "流程",
"cityId": 0,
"cityName": "石家庄市"
}
]
}
接口地址:/api/web/user/detail
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"userId": 0
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | |
| 邮箱 | string | ||
| roles | 角色列表 | array | GetUserDetailRoleVo |
| roleId | 角色id | integer | |
| cityId | 地区id | integer | |
| roleName | 角色名称 | string | |
| cityName | 地市名称 | string | |
| system | 系统id | string | |
| systemName | 系统名称 | string |
响应示例:
{
"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": "流程"
}
]
}
}
接口地址:/api/web/user/del
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"userIds": []
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {}
}
接口地址:/api/web/user/copyRole
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"userIds": [],
"roles": [
{
"roleId": 0,
"cityId": 0,
"roleName": "工单查询",
"cityName": "石家庄市",
"functionId": 0
}
]
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| default | default response | RObject |
| 无法修改非本地市用户 | {"success":false,"code":0,"message":"无法修改非本地市用户","data":null} |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| success | 是否成功 | boolean | |
| code | 业务码 | integer(int32) | integer(int32) |
| message | 提示信息 | string | |
| data | 数据 | object |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {}
}
接口地址:/api/web/user/add
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"loginName": "zhangsan",
"email": "",
"roles": [
{
"roleId": 0,
"cityId": 0,
"roleName": "工单查询",
"cityName": "石家庄市",
"functionId": 0
}
]
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| addUserDto | AddUserDto | body | true | AddUserDto | AddUserDto |
| loginName | 账号 | true | string | ||
| 邮箱 | false | string | |||
| roles | 角色列表 | false | array | AddUserRoleDto | |
| roleId | 角色id | true | integer | ||
| cityId | 地市id | true | integer | ||
| roleName | 角色名称 | true | string | ||
| cityName | 地市名称 | true | string | ||
| functionId | 功能id | false | integer |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 无法添加非本地市用户 | {"success":false,"code":0,"message":"无法添加非本地市用户","data":null} | |
| default | default response | RObject |
| 用户已存在系统中 | {"success":false,"code":0,"message":"用户已存在系统中","data":null} |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| success | 是否成功 | boolean | |
| code | 业务码 | integer(int32) | integer(int32) |
| message | 提示信息 | string | |
| data | 数据 | object |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {}
}
接口地址:/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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": [
{
"system": "flow",
"systemName": "流程"
}
]
}
接口地址:/api/web/role/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"current": 1,
"pageSize": 10,
"roleName": "工单",
"system": "flow"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"total": 1000,
"list": [
{
"roleName": "工单查询",
"system": "flow",
"systemName": "流程",
"roleDescription": ""
}
]
}
}
接口地址:/api/web/role/all
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
暂无
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RListAllRoleVo |
响应参数:
| 参数名称 | 参数说明 | 类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": [
{
"roleId": 0,
"functionId": 0,
"roleName": "工单查询",
"system": "flow",
"systemName": "流程"
}
]
}
接口地址:/api/web/log/verificationLog/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"current": 1,
"pageSize": 10,
"userId": 0,
"loginName": "zhangsan",
"userName": "张三",
"startTime": "",
"endTime": "",
"system": "flow",
"cityId": 0
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"total": 1000,
"list": [
{
"userId": 0,
"loginName": "zhangsan",
"userName": "张三",
"cityName": "石家庄市",
"systemName": "流程",
"loginTime": ""
}
]
}
}
接口地址:/api/web/log/verificationLog/export
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"userId": 0,
"loginName": "zhangsan",
"userName": "张三",
"operationName": "修改用户",
"startTime": "",
"endTime": "",
"system": "flow",
"cityId": 0
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"url": ""
}
}
接口地址:/api/web/log/operationLog/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"current": 1,
"pageSize": 10,
"operatorId": 0,
"operatorAccount": "zhangsan",
"operatorName": "张三",
"operationName": "修改用户",
"startTime": "",
"endTime": ""
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"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
响应数据类型:*/*
接口描述:
请求示例:
{
"operatorId": 0,
"operatorAccount": "zhangsan",
"operatorName": "张三",
"operationName": "修改用户",
"startTime": "",
"endTime": ""
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"url": ""
}
}
接口地址:/api/web/function/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"current": 1,
"pageSize": 10,
"functionName": "工单",
"client": 0,
"system": "flow"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | RPageVoListFunctionVo |
响应参数:
| 参数名称 | 参数说明 | 类型 | 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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"total": 1000,
"list": [
{
"functionId": 0,
"functionName": "工单查询",
"systemName": "流程",
"clientName": "app",
"functionDescription": "",
"appPriority": 0,
"webPriority": 0,
"webUrl": "",
"appUrl": "",
"webIcon": "",
"appIcon": ""
}
]
}
}
接口地址:/api/web/area/tree
请求方式: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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"label": "河北省",
"value": -1,
"children": [
{
"label": "河北省",
"value": -1,
"children": [
{}
]
}
]
}
}
接口地址:/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 |
响应示例:
{
"success": true,
"code": 0,
"message": "成功",
"data": {
"label": "河北省",
"value": -1,
"children": [
{
"label": "河北省",
"value": -1,
"children": [
{}
]
}
]
}
}
接口地址:/api/verification
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"token": "test_token_hebei",
"system": "web",
"fromSystem": "test"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| tokenVo | TokenVo | body | true | TokenVo | TokenVo |
| token | token | true | string | ||
| system | system | true | string | ||
| fromSystem | fromSystem | true | string |
响应状态:
| 状态码 | 说明 | 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 |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| userName | 用户名 | string | |
| list | 入口列表 | array | WebFunctionVo |
| id | 功能id | integer(int32) | |
| name | 功能名称 | string | |
| url | web链接 | string | |
| webIcon | web图标 | string | |
| priority | 显示优先级 | integer(int32) |
响应示例:
{
"userName": "张三",
"list": [
{
"id": 0,
"name": "",
"url": "",
"webIcon": "",
"priority": 0
}
]
}