HTTP/HTTPS
请求协议
YesDev / WebAPI / 获取角色树状层级列表
获取角色树状层级列表
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Roles.GetRoleList
接口描述: 获取角色树状层级列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
return_tree | 布尔型 | 可选 | false | 是否返回树状层级 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.list | 数组 | 角色层级列表 |
data.list[].id | 整型 | 角色ID(小于1000表示系统预设的角色) |
data.list[].parent_id | 整型 | 上级角色ID,顶级角色ID为0 |
data.list[].role_status | 整型 | 角色状态,1正常0禁用 |
data.list[].staff_total | 整型 | 成员人数 |
data.list[].role_name | 字符串 | 角色名称 |
data.list[].assign_op_id_list | 数组 | 角色分配的操作ID列表数组 |
data.list[].children | 数组 | (若有)子角色,没有时无此字段 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
return_tree | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"list": [
{
"id": 105,
"parent_id": 0,
"role_name": "普通成员",
"role_status": 1,
"staff_total": 71,
"assign_op_id_list": [1, 2, 3, 4]
},
{
"id": 199,
"parent_id": 0,
"role_name": "企业管理员",
"role_status": 1,
"staff_total": 4,
"assign_op_id_list": [1, 2, 3, 4]
}
]
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-08 10:44:07 联系我们开通接入OpenAPI