HTTP/HTTPS
请求协议
YesDev / WebAPI / 搜索员工
搜索员工
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Staff.SearchStaff
接口描述: 员工下拉列表,支持名字或工号搜索。仅显示在职员工。
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
keyword | 字符串 | 可选 | 需要搜索的员工名字或工号 | ||
page | 整型 | 可选 | 1 | 当前页数 | |
perpage | 整型 | 可选 | 10 | 每页多少条 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.total | 整型 | 总数 |
data.items | 数组 | 员工列表 |
data.items[].id | 整型 | 员工ID |
data.items[].staff_no | 字符串 | 员工编号 |
data.items[].staff_name | 字符串 | 员工名字 |
data.items[].staff_title | 字符串 | 员工职位 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
keyword | 可选 | |
page | 可选 | |
perpage | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"total": 10,
"items": [
{
"id": 9,
"staff_no": "200001",
"staff_name": "张三2",
"staff_title": ""
},
{
"id": 12,
"staff_no": "200004",
"staff_name": "张三2",
"staff_title": ""
}
],
"page": 3,
"perpage": 2
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-08 10:40:39 联系我们开通接入OpenAPI