YesDev / WebAPI / 更新员工

更新员工

接口描述: 更新员工

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
id字符串必须-id
staff_no字符串必须-员工编号
staff_name字符串必须-最大:100员工姓名
mobile字符串可选-最大:20手机号
email字符串可选最大:100邮箱
note字符串可选备注
department_id整型可选0部门ID
staff_status整型可选1最小:0;最大:2状态,2未授权1在职0离职
access_status整型可选0访问模式 0正常 100是访客模式
is_set_admin整型可选0是否设置为admin
staff_type整型可选0成员类型,1普通成员 2企业管理员 20 访客 30上级
post字符串可选岗位
cost字符串可选0成本
work_group_ids字符串可选-工作组ids

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.is_updated整型是否更新成功
data.is_update_username整型是否更换登录账号
data.is_update_password整型是否修改登录密码
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
id 必须
staff_no 必须
staff_name 必须
mobile 可选
email 可选
note 可选
department_id 可选
staff_status 可选
access_status 可选
is_set_admin 可选
staff_type 可选
post 可选
cost 可选
work_group_ids 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Staff.UpdateStaff.json

错误列表

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

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