获取角色列表

优质

小牛编辑

122浏览

2023-12-01

接口说明

获取角色列表
如需调用，请访问开发者文档来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者
如开启https功能，请求地址的协议应改为https，如：https://www.example.com/wish3dearth/api/access/v1.0.0/getLicenseInfo

API地址

GET /permissions/api/team/role/v1.0.0/list

是否需要登录

是

请求字段说明

参数	类型	请求类型	是否必须	说明
token	string	header	是	当前登录用户的TOKEN
sidx	string	query	否	排序字段名称（去驼峰模式中间用下划线隔开）
order	string	query	否	排序方式（asc或desc）
page	string	query	是	当前页（从1开始）
limit	string	query	是	每页显示记录条数

响应字段说明

参数	类型	说明
totalCount	number	总条数
pageSize	number	每页条数
totalPage	number	总页
currPage	number	当前页
list	array	角色列表

响应成功示例

{
  "code": 0,
  "data": {
    "totalCount": 2,
    "pageSize": 9999,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": "a87a3ece045b4794ac5e54760dff07df",
        "name": "预览",
        "defaultRole": "0",
        "remarks": null,
        "teamId": "af337a35d3eb4e62a8732ee2f062f2ea",
        "createBy": "289baa7eb41a421c9014fb1a00c887de",
        "createDate": "2019-12-11 14:27:08",
        "updateBy": "289baa7eb41a421c9014fb1a00c887de",
        "updateDate": "2019-12-11 14:27:08",
        "permissionsList": null
      }
    ]
  },
  "message": "成功"
}

响应失败示例

{
  "code": 500,
  "message": "未知错误，请及时联系管理人员进行处理"
}

响应接受类型

application/json

响应状态码

HTTP状态码	原因
0	成功
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
10000	token不能为空
10001	token已失效,请重新登录
15011	用户团队信息错误
99998	非法请求
99999	服务器异常

示例代码

$.ajax({

    url: '/permissions/api/team/role/v1.0.0/list?token=&sidx=&order=&page=&limit=',

    type: 'GET',

    data: '',

    dataType: 'text',

    cache: false,

    contentType: 'application/json',

    xhrFields: {

        withCredentials: true

    },

    crossDomain: true,

    success:function(data){

        // 成功返回值

    },

    error:function(XMLHttpRequest, textStatus, errorThrown){

    

    }

})