HTTP/HTTPS
请求协议
YesDev / WebAPI / 获取员工列表
获取员工列表
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Staff.GetStaffList
接口描述: 获取员工列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
staff_no | 字符串 | 可选 | - | 员工编号 | |
staff_name | 字符串 | 可选 | - | 最大:100 | 员工姓名,支持模糊搜索 |
department_id | 整型 | 可选 | 0 | 部门ID | |
staff_status | 整型 | 可选 | - | 员工状态 不传这个字段过来代表全部 0离职1在职2未授权 | |
page | 整型 | 可选 | 1 | 当前页数 | |
perpage | 整型 | 可选 | 10 | 每页多少条 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.total | 整型 | 员工总数 |
data.items | 数组 | 列表 |
data.items[].staff_member_name | 字符串 | 登录账号 |
data.items[].department_name | 字符串 | 部门名称 |
data.items[].is_company_admin | 整型 | 是否企业管理员,1是0否 |
data.items[].staff_role_name | 字符串 | 成员角色名称(20240506新增) |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
staff_no | 可选 | |
staff_name | 可选 | |
department_id | 可选 | |
staff_status | 可选 | |
page | 可选 | |
perpage | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"total": 1,
"items": [
{
"id": 1,
"staff_no": "007",
"staff_name": "周星星2",
"mobile": "",
"department_id": 2,
"staff_status": 1,
"email": "",
"note": "test",
"app_key": "gctest",
"staff_member_name": "GC200001",
"add_time": "2020-10-06 14:50:26"
}
],
"page": 1,
"perpage": 100
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-08 10:50:18 联系我们开通接入OpenAPI