YesDev / WebAPI / 查询员工

查询员工

接口描述: 查询员工信息

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
staff_no字符串必须-员工编号

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.staff对象员工不存在时为null
data.staff.staff_status整型状态,0离职1在职2未授权
msg字符串提示信息,失败时的错误提示

在线测试   

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

客户端请求示例

{
    "ret": 200,
    "data": {
        "staff": {
            "id": 1,
            "staff_no": "007",
            "staff_name": "周星星",
            "mobile": "",
            "department_id": 2,
            "staff_status": 1,
            "email": "",
            "note": "test",
            "app_key": "gctest",
            "add_time": "2020-10-06 14:50:26"
        }
    },
    "msg": ""
}

错误列表

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

本文档生成时间:2024-04-27 18:05:54 联系我们开通接入OpenAPI