YesDev / WebAPI / 获取工作组列表

获取工作组列表

接口描述: 获取工作组列表

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
show_all整型可选0展示该公司公有的及受包含的及自己有权限的工作组。 0 默认展示自己有权限 1展示展示该公司公有的及受包含的及自己有权限的工作组

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.total整型总数
data.items数组列表
data.items[].staff_rights整型当前权限,1可编辑0不可编辑
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
show_all 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "workgroup_list": [
        {
            "id": 5,
            "workgroup_name": "第1战队",
            "workgroup_desc": "",
            "workgroup_avatar": "",
            "workgroup_rights": 0,
            "app_key": "gc",
            "add_time": "2020-11-04 10:25:56",
            "created_staff_id": 13,
            "admin_id": 1,
            "staff_num": 3,
            "project_num": 0,
            "staff_rights": 1
        }
        ]
    },
    "msg": ""
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
410权限不足
500表示服务端内部错误

本文档生成时间:2024-04-27 19:35:32 联系我们开通接入OpenAPI