Skip to content

Page Data

zifangsky edited this page Dec 8, 2020 · 2 revisions

页面数据相关接口文档

查询当前登录用户的基本信息

此接口用于查询当前登录用户的基本信息。

请求URL:

/user/selectUserInfo

请求方式:

  • GET
  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "A529QsGkSiO0",
    "time": "2020-11-17 13:50:31",
    "data": {
        "user_info": {
            "username": "admin",
            "name": "超级管理员",
            "phone": "12345678909",
            "email": "",
            "userType": 1,
            "institutionId": null,
            "status": 0,
            "isDel": false,
            "loginIp": "127.0.0.1",
            "loginTime": "2020-11-17 13:49:59",
            "creator": null,
            "createTime": "2017-08-10 00:00:01"
        }
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

user_info参数:

参数名 类型 说明
username String 用户登录名
name String 用户昵称
phone String 手机号
email String 邮箱
userType Integer 用户类型。0:后台用户;1:前台用户
institutionId Integer 机构id
status Integer 用户状态。0:可用;1:锁定;2:未开通
isDel Boolean 标识该用户是否已经被删除
loginIp String 登录IP
loginTime String 登录时间。返回格式是:yyyy-MM-dd HH:mm:ss
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

查询当前用户拥有的所有角色和资源

此接口用于查询当前用户拥有的所有角色和资源。

请求URL:

/user/selectRoleAndFunc

请求方式:

  • GET
  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ab29QueWRuWu",
    "time": "2020-11-17 13:52:41",
    "data": {
        "roles": [
            {
                "id": 1,
                "name": "manager",
                "description": "超级管理员",
                "status": 0,
                "institutionId": null,
                "creator": "admin",
                "createTime": "2017-07-11 13:53:13"
            }
        ],
        "funcs": [
            {
                "id": 2,
                "myselfId": "manage-10",
                "parentId": "manage-0",
                "name": "测试权限1",
                "type": 1,
                "level": 1,
                "pathUrl": "/aaa/bbb",
                "iconUrl": "",
                "sequenceNum": 1,
                "state": 0,
                "description": "测试权限1",
                "institutionId": "",
                "createTime": "2019-03-20 00:00:03",
                "creator": ""
            },
            {
                "id": 1,
                "myselfId": "manage-0",
                "parentId": "0",
                "name": "所有权限",
                "type": 1,
                "level": 0,
                "pathUrl": "",
                "iconUrl": "",
                "sequenceNum": 0,
                "state": 0,
                "description": "所有权限",
                "institutionId": "",
                "createTime": "2017-06-28 18:53:53",
                "creator": "wxn"
            }
        ]
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

参数名 类型 说明
roles Set<SysRole> 用户所属的角色信息
funcs Set<SysFunction> 用户拥有的权限/资源信息

SysRole参数:

参数名 类型 说明
id Long 主键ID
name String 角色名
description String 描述信息
status Integer 状态。0:正常;1:删除
institutionId Integer 机构id
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

SysFunction参数:

参数名 类型 说明
id Long 主键ID
myselfId String 自身唯一标识ID
parentId String 父级资源项ID ,取myselfid值
name String 权限/资源名称
type Integer 资源类型。 1.菜单 2.按钮
level Integer 层级。1.一级导航菜单 2.二级导航菜单 3.功能按钮
pathUrl String 权限CODE,默认使用其接口路径表示
iconUrl String 图标路径
sequenceNum Integer 排序
state Integer 状态。0:正常;1:删除
institutionId String 机构id
description String 资源项描述
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

分页查询用户列表

此接口用于分页查询用户列表。

请求URL:

/user/findAll

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
current_page String 当前页,比如1表示第一页,如果不填则默认查询第一页,如果填入的页数超过最大页面,则查询最后一页
page_size String 每页展示数,如果不填则默认为10
sort_name String 排序字段,如果不填则默认为id
sort_order String 排序顺序,可以填ASC或者DESC,如果不填则默认为ASC
query_param String 查询条件,在这里表示对用户名、用户昵称、手机号、邮箱这几个字段的模糊查询

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ai29QvdElLzU",
    "time": "2020-11-17 13:53:33",
    "data": {
        "list": [
            {
                "id": 1,
                "username": "admin",
                "name": "超级管理员",
                "password": "21232f297a57a5a743894a0e4a801fc3",
                "encryptMode": "Md5Hex",
                "phone": "12345678909",
                "email": "",
                "userType": 1,
                "institutionId": null,
                "status": 0,
                "isDel": false,
                "loginIp": "127.0.0.1",
                "loginTime": "2020-11-17 13:49:59",
                "creator": null,
                "createTime": "2017-08-10 00:00:01",
                "role": {
                    "id": 1,
                    "name": "manager",
                    "description": "超级管理员",
                    "status": 0,
                    "institutionId": null,
                    "creator": "admin",
                    "createTime": "2017-07-11 13:53:13"
                }
            }
        ],
        "pageInfo": {
            "count": 1,
            "pageCount": 1,
            "pageSize": 2,
            "currentPage": 1,
            "sortName": "id",
            "sortOrder": "ASC"
        }
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

参数名 类型 说明
list List<SysUser> 用户信息
pageInfo PageInfo 分页信息

SysUser参数:

参数名 类型 说明
id Long 主键ID
username String 用户登录名
name String 用户昵称
password String 密码
encryptMode String 密码加密方式
phone String 手机号
email String 邮箱
userType Integer 用户类型。0:后台用户;1:前台用户
institutionId Integer 机构id
status Integer 用户状态。0:可用;1:锁定;2:未开通
isDel Boolean 标识该用户是否已经被删除
loginIp String 登录IP
loginTime String 登录时间。返回格式是:yyyy-MM-dd HH:mm:ss
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

PageInfo参数:

参数名 类型 说明
count Long 数据总数
pageCount Long 页数
pageSize Integer 每页展示数据量
currentPage Integer 当前页
sortName String 按照什么字段排序
sortOrder String ASC(正序)、DESC(倒序)

检查用户名是否重复

此接口用于检查用户名是否重复。

请求URL:

/user/checkName

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
username String 待检查的用户名

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Aj29RA6wKbXk",
    "time": "2020-11-17 14:06:38",
    "data": {
        "valid": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Aj29RA6wKbXl",
    "time": "2020-11-17 14:06:39",
    "data": {
        "valid": "false"
    }
}

返回参数说明:

参数名 类型 说明
valid String 返回状态码。true表示该用户名未被使用;false表示该用户名已经存在

检查手机号是否重复

此接口用于检查手机号是否重复。

请求URL:

/user/checkPhone

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
phone String 待检查的手机号码

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AY29RBUzH0To",
    "time": "2020-11-17 14:07:53",
    "data": {
        "valid": "false"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AY29RBUzH0Tz",
    "time": "2020-11-17 14:07:54",
    "data": {
        "valid": "false"
    }
}

返回参数说明:

参数名 类型 说明
valid String 返回状态码。true表示该手机号未被使用;false表示该手机号已经存在

新增/编辑用户信息

此接口用于新增/编辑用户信息。

请求URL:

/user/addOrEdit

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
roleId Long 角色ID
id Long 主键ID
username String 用户登录名
name String 用户昵称
password String 密码
encryptMode String 密码加密方式
phone String 手机号
email String 邮箱
userType Integer 用户类型。0:后台用户;1:前台用户
institutionId Integer 机构id
status Integer 用户状态。0:可用;1:锁定;2:未开通
isDel Boolean 标识该用户是否已经被删除
loginIp String 登录IP
loginTime String 登录时间。返回格式是:yyyy-MM-dd HH:mm:ss
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

注:修改用户时只有发生改变的字段才会相应被修改。

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Al29RDSzAYJU",
    "time": "2020-11-17 14:09:40",
    "data": {
        "code": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Al29RDSzAYJU",
    "time": "2020-11-17 14:09:40",
    "data": {
        "code": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "新增用户出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
code String 返回状态码。true表示修改成功;false表示修改失败

删除用户(逻辑删除)

此接口用于删除用户(逻辑删除,也就是在数据库中为记录添加一个删除标识,但是不会实际删除数据库中的记录)。

请求URL:

/user/delete

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
id Long 主键ID

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "A829RNbsop7I",
    "time": "2020-11-17 14:18:49",
    "data": {
        "result": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "A829RNbsop7I",
    "time": "2020-11-17 14:18:49",
    "data": {
        "result": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "删除用户出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
result String 返回状态码。true表示删除成功;false表示删除失败

分页查询角色列表

此接口用于分页查询角色列表。

请求URL:

/role/findAll

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
current_page String 当前页,比如1表示第一页,如果不填则默认查询第一页,如果填入的页数超过最大页面,则查询最后一页
page_size String 每页展示数,如果不填则默认为10
sort_name String 排序字段,如果不填则默认为id
sort_order String 排序顺序,可以填ASC或者DESC,如果不填则默认为ASC
query_param String 查询条件,在这里表示对角色名的模糊查询

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AA29RP94GAtc",
    "time": "2020-11-17 14:20:12",
    "data": {
        "list": [
            {
                "id": 2,
                "name": "测试角色",
                "description": "1",
                "status": 0,
                "institutionId": null,
                "creator": null,
                "createTime": null
            },
            {
                "id": 1,
                "name": "manager",
                "description": "超级管理员",
                "status": 0,
                "institutionId": null,
                "creator": "admin",
                "createTime": "2017-07-11 13:53:13"
            }
        ],
        "pageInfo": {
            "count": 2,
            "pageCount": 1,
            "pageSize": 20,
            "currentPage": 1,
            "sortName": "id",
            "sortOrder": "DESC"
        }
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

参数名 类型 说明
list List<SysRole> 角色信息
pageInfo PageInfo 分页信息

SysRole参数:

参数名 类型 说明
id Long 主键ID
name String 角色名
description String 描述信息
status Integer 状态。0:正常;1:删除
institutionId Integer 机构id
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

PageInfo参数:

参数名 类型 说明
count Long 数据总数
pageCount Long 页数
pageSize Integer 每页展示数据量
currentPage Integer 当前页
sortName String 按照什么字段排序
sortOrder String ASC(正序)、DESC(倒序)

检查角色名是否重复

此接口用于检查角色名是否重复。

请求URL:

/role/checkName

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
roleName String 待检查的角色名

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "At29RRNW6rrc",
    "time": "2020-11-17 14:22:13",
    "data": {
        "valid": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "At29RRNW6rrc",
    "time": "2020-11-17 14:22:13",
    "data": {
        "valid": "false"
    }
}

返回参数说明:

参数名 类型 说明
valid String 返回状态码。true表示该角色名未被使用;false表示该角色名已经存在

新增/编辑角色信息

此接口用于新增/编辑角色信息。

请求URL:

/role/addOrEdit

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
funcIdStr String 权限/资源ID的字符串,以英文逗号隔开,比如:2,5,6,7
id Long 主键ID
name String 角色名
description String 描述信息
status Integer 状态。0:正常;1:删除
institutionId Integer 机构id
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

注:修改角色时只有发生改变的字段才会相应被修改。

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ax29RSdqTZUu",
    "time": "2020-11-17 14:23:22",
    "data": {
        "result": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ax29RSdqTZUu",
    "time": "2020-11-17 14:23:22",
    "data": {
        "result": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "新增角色出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
result String 返回状态码。true表示修改成功;false表示修改失败

删除角色

此接口用于删除角色(物理删除)。

请求URL:

/role/delete

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
id Long 主键ID

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ah29RVSWfL4y",
    "time": "2020-11-17 14:25:54",
    "data": {
        "result": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ah29RVSWfL4y",
    "time": "2020-11-17 14:25:54",
    "data": {
        "result": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "删除角色出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
result String 返回状态码。true表示删除成功;false表示删除失败

分页查询资源列表

此接口用于分页查询资源列表。

请求URL:

/func/findAll

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
current_page String 当前页,比如1表示第一页,如果不填则默认查询第一页,如果填入的页数超过最大页面,则查询最后一页
page_size String 每页展示数,如果不填则默认为10
sort_name String 排序字段,如果不填则默认为id
sort_order String 排序顺序,可以填ASC或者DESC,如果不填则默认为ASC
query_param String 查询条件,在这里表示对资源名的模糊查询

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AA29RWLUSbAW",
    "time": "2020-11-17 14:26:42",
    "data": {
        "list": [
            {
                "id": 2,
                "myselfId": "manage-10",
                "parentId": "manage-0",
                "name": "测试权限1",
                "type": 1,
                "level": 1,
                "pathUrl": "/aaa/bbb",
                "iconUrl": "",
                "sequenceNum": 1,
                "state": 0,
                "description": "测试权限1",
                "institutionId": "",
                "createTime": "2019-03-20 00:00:03",
                "creator": ""
            },
            {
                "id": 1,
                "myselfId": "manage-0",
                "parentId": "0",
                "name": "所有权限",
                "type": 1,
                "level": 0,
                "pathUrl": "",
                "iconUrl": "",
                "sequenceNum": 0,
                "state": 0,
                "description": "所有权限",
                "institutionId": "",
                "createTime": "2017-06-28 18:53:53",
                "creator": "wxn"
            }
        ],
        "pageInfo": {
            "count": 2,
            "pageCount": 1,
            "pageSize": 20,
            "currentPage": 1,
            "sortName": "id",
            "sortOrder": "DESC"
        }
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

参数名 类型 说明
list List<SysFunction> 资源信息
pageInfo PageInfo 分页信息

SysFunction参数:

参数名 类型 说明
id Long 主键ID
myselfId String 自身唯一标识ID
parentId String 父级资源项ID ,取myselfid值
name String 权限/资源名称
type Integer 资源类型。 1.菜单 2.按钮
level Integer 层级。1.一级导航菜单 2.二级导航菜单 3.功能按钮
pathUrl String 权限CODE,默认使用其接口路径表示
iconUrl String 图标路径
sequenceNum Integer 排序
state Integer 状态。0:正常;1:删除
institutionId String 机构id
description String 资源项描述
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

查询所有资源(不分页)

此接口用于查询所有资源(不分页)。

请求URL:

/func/selectAll

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

返回示例:

正确时返回:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Ar29RXvCaWkS",
    "time": "2020-11-17 14:28:08",
    "data": {
        "list": [
            {
                "id": 1,
                "myselfId": "manage-0",
                "parentId": "0",
                "name": "所有权限",
                "type": 1,
                "level": 0,
                "pathUrl": "",
                "iconUrl": "",
                "sequenceNum": 0,
                "state": 0,
                "description": "所有权限",
                "institutionId": "",
                "createTime": "2017-06-28 18:53:53",
                "creator": "wxn"
            },
            {
                "id": 2,
                "myselfId": "manage-10",
                "parentId": "manage-0",
                "name": "测试权限1",
                "type": 1,
                "level": 1,
                "pathUrl": "/aaa/bbb",
                "iconUrl": "",
                "sequenceNum": 1,
                "state": 0,
                "description": "测试权限1",
                "institutionId": "",
                "createTime": "2019-03-20 00:00:03",
                "creator": ""
            }
        ]
    }
}

错误时返回:

{
    "msg": "查询出现异常,具体原因请查看日志!",
    "code": 500
}

返回参数说明:

参数名 类型 说明
list List<SysFunction> 资源信息

SysFunction参数:

参数名 类型 说明
id Long 主键ID
myselfId String 自身唯一标识ID
parentId String 父级资源项ID ,取myselfid值
name String 权限/资源名称
type Integer 资源类型。 1.菜单 2.按钮
level Integer 层级。1.一级导航菜单 2.二级导航菜单 3.功能按钮
pathUrl String 权限CODE,默认使用其接口路径表示
iconUrl String 图标路径
sequenceNum Integer 排序
state Integer 状态。0:正常;1:删除
institutionId String 机构id
description String 资源项描述
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

检查资源名是否重复

此接口用于检查资源名是否重复。

请求URL:

/func/checkName

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
name String 待检查的资源名
parentId String 父节点的主键ID

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "A229RZSSMGGG",
    "time": "2020-11-17 14:29:31",
    "data": {
        "valid": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "A229RZSSMGGG",
    "time": "2020-11-17 14:29:31",
    "data": {
        "valid": "false"
    }
}

返回参数说明:

参数名 类型 说明
valid String 返回状态码。true表示该资源名未被使用;false表示该资源名已经存在

新增/编辑资源信息

此接口用于新增/编辑资源信息。

请求URL:

/func/addOrEdit

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
id Long 主键ID
myselfId String 自身唯一标识ID
parentId String 父级资源项ID ,取myselfid值
name String 权限/资源名称
type Integer 资源类型。 1.菜单 2.按钮
level Integer 层级。1.一级导航菜单 2.二级导航菜单 3.功能按钮
pathUrl String 权限CODE,默认使用其接口路径表示
iconUrl String 图标路径
sequenceNum Integer 排序
state Integer 状态。0:正常;1:删除
institutionId String 机构id
description String 资源项描述
creater String 创建人
createTime String 创建时间。返回格式是:yyyy-MM-dd HH:mm:ss

注:修改资源时只有发生改变的字段才会相应被修改。

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Aw29RbR5HeTo",
    "time": "2020-11-17 14:31:18",
    "data": {
        "result": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "Aw29RbR5HeTo",
    "time": "2020-11-17 14:31:18",
    "data": {
        "result": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "新增资源出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
result String 返回状态码。true表示修改成功;false表示修改失败

删除资源

此接口用于删除资源(物理删除)。

请求URL:

/func/delete

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started

请求参数:

参数名 是否必须 类型 说明
access_token String 登录后返回的access_token请求头或者请求参数中携带都可以,其他携带方式可以参考:https://easylimit.zifangsky.cn/#/get_started
id Long 主键ID

返回示例:

正确时返回示例一:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AQ29RdOuxddA",
    "time": "2020-11-17 14:33:04",
    "data": {
        "result": "true"
    }
}

正确时返回示例二:

{
    "code": "0000",
    "msg": "处理成功",
    "tid": "AQ29RdOuxddA",
    "time": "2020-11-17 14:33:04",
    "data": {
        "result": "false"
    }
}

错误时返回示例:

{ 
    "code": "false",
    "msg": "删除资源出现异常,具体原因请查看日志!"
}

返回参数说明:

参数名 类型 说明
result String 返回状态码。true表示删除成功;false表示删除失败
Clone this wiki locally