APIUSB / 平台接口 / 分类目录详情

分类目录详情

接口描述: 分类目录详情

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
id整型必须-分类目录ID

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.item对象分类目录信息
data.item.id整型分类目录
data.item.folder_id整型统一编码10 Inbox, 20Sent, 30Drafts,40Spam,90Trash,100 开始,是用户自建目录
data.item.uuidstr用户uuid
data.item.depid整型部门ID
data.item.titlestr分类目录名称
data.item.creditsstr处理后获得的积分
data.item.iconstr图标
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
id 必须

客户端请求示例

{
    "ret": 200,
    "data": {
        "item": {
            "id": 1,
            "folder_id": 10,
            "type_id": 0,
            "uuid": "",
            "depid": 0,
            "title": "Inbox",
            "icon": "fa-comment-alt-dots",
            "credits": 0,
            "sortnum": 1,
            "update_time": "2020-06-29 06:11:20",
            "add_time": "2020-06-29 06:11:20"
        }
    },
    "msg": ""
}

错误列表

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

本文档生成时间:2024-04-27 11:15:48