启用/停用地点
启用/停用地点
Tip: - 停用地点时请确认有无在职员工、异动单据、待入职单据关联此地点,如有会导致停用失败。
- 若启/停用的生效时间当天不存在版本则会自动生成一个版本。
- 若启/停用的生效时间当天存在版本则会修改该版本。
- 详情可以参考时间轴介绍
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/locations/active |
| HTTP Method | POST |
| 接口频率限制 | 5 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:locations:write 更新地点信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
location_id | string | 是 | 地点 ID。ID 获取方式: - 调用【创建地点】【批量分页查询地点】等接口可以返回地点ID 示例值:"1616161616" |
effective_time | string | 是 | 地点启用/停用生效日期 - 填写格式:YYYY-MM-DD - 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日 - 日期范围要求:1900-01-01~9999-12-31 - 详情可以参考时间轴介绍 示例值:"2020-01-01" |
active | boolean | 是 | 地点启用/停用状态 - true 为启用 - false 为停用 示例值:true |
operation_reason | string | 是 | 操作原因 示例值:"业务操作" |
请求体示例
json
{
"location_id": "1616161616",
"effective_time": "2020-01-01",
"active": true,
"operation_reason": "业务操作"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}