Role API - Mrdaigithub/crm GitHub Wiki

Role API

功能描述：

获取role列表

请求URL：

http://xx.com/api/v1/roles/

请求方式：

参数：

参数名	必选	类型	说明

返回示例

[
	{
		"role_id": "1",
		"role_name": "root组",
		"role_state": "1",
		"role_must": "1"
	},
	{
		"role_id": "2",
		"role_name": "admin1",
		"role_state": "1",
		"role_must": "0"
	},
        ...
]

返回参数说明

参数名	类型	说明
role_id	Number	权限组ID
role_name	String	权限组名称
role_permission	String	权限组权限细节
role_state	Boolean	权限组启用状态
role_must	Boolean	权限组是否为固化组

错误状态码

参数名	说明
40010	缺少token参数
40014	无效的token
42001	token参数过期
48001	权限不足

功能描述：

新建一个权限组

请求URL：

http://xx.com/api/v1/roles/

请求方式：

POST

参数：

参数名	必选	类型	说明
new_role_name	是	String	新建的权限组名称

返回示例

{
	"role_id": "50",
	"role_name": "admin",
	"role_permission": "00000000000000000000000000000000000000000000000000000000000000000",
	"role_state": "0",
	"role_must": "0"
}

返回参数说明

参数名	类型	说明
role_id	Number	新建的权限组ID
role_name	String	新建的权限组名称
role_permission	String	新建的权限组权限细节
role_state	Boolean	新建的权限组启用状态
role_must	Boolean	新建的权限组是否为固化组

错误状态码

参数名	说明
40010	缺少token参数
40014	无效的token
42001	token参数过期
48001	权限不足
44001	参数缺失
46007	权限组已存在

功能描述：

删除指定权限组

请求URL：

` http://xx.com/api/v1/roles/ID

请求方式：

DELETE

参数：

参数名	必选	类型	说明

返回示例

返回参数说明

参数名	类型	说明

错误状态码

参数名	说明
40010	缺少token参数
40014	无效的token
42001	token参数过期
48001	权限不足

功能描述：

更新权限组启用状态

请求URL：

http://xx.com/api/v1/roles/state/ID

请求方式：

PATCH

参数：

参数名	必选	类型	说明
role_state	是	Boolean	改变的权限组启用状态

返回示例

{
	"role_id": "51",
	"role_name": "admin",
	"role_permission": "00000000000000000000000000000000000000000000000000000000000000000",
	"role_state": "1",
	"role_must": "0"
}

返回参数说明

参数名	类型	说明
role_id	Number	权限组ID
role_name	String	权限组名称
role_permission	String	权限组权限细节
role_state	Boolean	修改后的权限组启用状态
role_must	Boolean	权限组是否为固化组

错误状态码

参数名	说明
40010	缺少token参数
40014	无效的token
42001	token参数过期
48001	权限不足
44001	参数缺失
46008	权限组不存在

功能描述：

更新权限组名称

请求URL：

http://xx.com/api/v1/roles/name/ID

请求方式：

PATCH

参数：

参数名	必选	类型	说明
new_role_name	是	Boolean	改变的权限组名称

返回示例

{
	"role_id": "52",
	"role_name": "admins",
	"role_permission": "00000000000000000000000000000000000000000000000000000000000000000",
	"role_state": "0",
	"role_must": "0"
}

返回参数说明

参数名	类型	说明
role_id	Number	权限组ID
role_name	String	修改后的权限组名称
role_permission	String	权限组权限细节
role_state	Boolean	权限组启用状态
role_must	Boolean	权限组是否为固化组

错误状态码

参数名	说明
40010	缺少token参数
40014	无效的token
42001	token参数过期
48001	权限不足
44001	参数缺失
46008	权限组不存在
46009	权限组名称已存在