角色管理

1. 获取角色列表（getRoleList）

前端： 彭琼
后端： 况俊飚
url： /v1/homing/system/web/role/page-list
备注： WEB-角色-分页列表

//! 注意，TS版本4^
import type { GetRoleListReq, GetRoleListRes } from '@homing/web'

homingClient.getRoleList({
  pageIndex: '1',
  pageRows: '10',
  roleName: '企业管理员',
}).then((res: any) => {
  console.log('角色列表', res.list);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
roleName	string	否	角色名称
description	string	否	角色描述
state	number	否	状态	1启用；0禁用
orderBy	string	否	排序规则
roleRank	string	否	角色级别
orgCode	string	否	机构编码
pageIndex	number	是	页码
pageRows	number	是	行数

响应说明

字段名	类型	说明
list	RoleListItem[]	数据列表
pager	Pager	分页信息

RoleListItem

字段名	类型	说明
category	string	分类 1企业 2总部 3门店
description	string	角色描述
grantOrgs	RoleGrantOrg[]	角色授予机构列表
roleCode	string	角色标识
roleName	string	角色名称
state	number	状态 0:禁用；1:启用
org	RoleOrgInfo	所属机构
readonly	number	内置，0:否 1:是
createdTime	number	创建时间
createdBy	string	创建人

RoleGrantOrg

字段	类型	说明
orgId	number	机构id，0:全部店铺
orgCode	string	机构code
orgName	string	机构名称
orgType	string	机构类别 1企业 2总部 3门店

RoleOrgInfo

字段	类型	说明
orgCode	string	机构code
orgName	string	机构名称
orgType	string	机构类别 1企业 2总部 3门店

Pager

字段	类型	说明
totalRows	number	总记录数
pageRows	number	每一页条数
pageIndex	number	当前页索引
paged	boolean	是否已分页
totalPages	number	总页数
pageEndRow	number	页结束条数
defaultPageRows	number	默认页条数
currPageRows	number	当前页条数
pageStartRow	number	页开始条数
hasPrevPage	boolean	是否有上一页
hasNextPage	boolean	是否有下一页

2. 获取角色详情（getRoleInfo）

前端： 彭琼
后端： 况俊飚
url： /v1/homing/system/web/role/get
备注： WEB-角色-获取详情

//! 注意，TS版本4^
import type { GetRoleInfoReq, GetRoleInfoRes } from '@homing/web'

homingClient.getRoleInfo({
  roleId: "1933779158082248704"
}).then((res: any) => {
  console.log('角色详情', res);
});

3. 更新角色信息（updateRoleInfo）

前端： 彭琼
后端： 况俊飚
url： /v1/homing/system/web/role/update
备注： WEB-角色-更新

//! 注意，TS版本4^
import type { UpdateRoleReq } from '@homing/web' 

try {
    await client.updateRoleInfo({
        roleId: '1933779158082248704',
        roleName: '企业管理员',
        state: 1,
        description: '',
        orgCodes: '6692',
        category: '1',
        roleCode: '2865',
        grantOrgIds: 0,
    } as UpdateRoleReq);
    console.log('更新成功');
} catch (error: any) {
    console.log(error, '更新失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
roleId	string	是	角色ID
roleName	string	是	角色名称	-
description	string	是	描述	-
state	string	是	状态	0=禁用, 1=启用
resourceCodes	string	否	资源codes	可选参数，多个code用逗号分隔
orgCodes	string	是	机构codes	多个code用逗号分隔
category	string	是	角色类别	1=企业, 2=总部/区域, 3=门店
roleCode	string	是	角色标识	-
grantOrgIds	string[]	是	授予机构id列表，0:全部店铺	-

响应说明

无

4. 添加角色（addRole）

前端： 彭琼
后端： 况俊飚
url： /v1/homing/system/web/role/add
备注： WEB-角色-添加

//! 注意，TS版本4^
import type { AddRoleReq } from '@homing/web' 

try {
    await client.addRole({
        roleName: '测试角色',
        state: 1,
        description: 'test',
        category: '3',
        dataperms: {'1643506345221283840':'30'},
        grantOrgIds: [''],
    } as AddRoleReq);
    console.log('添加成功');
} catch (error: any) {
    console.log(error, '添加失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
roleName	string	是	角色名称	-
description	string	否	描述	-
state	string	是	状态	0=禁用, 1=启用
bindResourceIds	string[]	否	资源id列表	可选参数
grantOrgIds	string[]	是	授予机构id列表，0:全部店铺	-
category	string	是	角色类别	1=企业, 2=总部, 3=门店
dataperms	Record<number, string>	是	数据权限	key为datapermId，value为datascope

响应说明

字段	类型	说明
roleId	string	角色id
roleCode	string	角色code
orgId	string	机构id
tenantCode	string	租户code
roleName	string	角色名称
category	string	角色类别
roleRank	string	角色等级
grantOrgs	string[]	授权机构id的列表

5. 删除角色（removeRole）

前端： 彭琼
后端： 况俊飚
url： /v1/homing/system/web/role/delete
备注： WEB-角色-删除

client.removeRole({
    orgId: '1943231421573619712'
}).then((res: any) => {
  console.log('删除成功');
});

参数说明

参数名	类型	必填	说明	备注/枚举值
roleId	string	是	角色ID

响应说明

无

6. WEB-角色-获取管理员资源列表（getCurrentRole）

前端： 陈小欢
后端： 况俊飚
url： v1/homing/system/web/role/admin/get-current

client.getCurrentRole({}).then(res => {
    console.log(res, '角色资源获取成功');
  })

参数说明

Query Params 参数
暂时无法在飞书文档外展示此内容

响应说明

响应数据类型：json
暂时无法在飞书文档外展示此内容