更改当前登录用户的工作开放时间设置。
Request
HTTP request
PATCH https://www.featapi.com/api/user/opentime/
Parameters
无需添加参数。
Authorization
该请求需要授权以下scopes访问权限:
Scopes |
---|
user_opentime |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a User.opentime resource with the following properties:
Property name | Value | Description | Notes |
必填 | |||
records | list | 工作开放时间的设置 | 特定JSON数据格式,详情请查看下文 |
timezone | string | 工作开放时间的时区 | 默认:UTC。必须是TZ database的时区名称,比如”Asia/Shanghai”。详情请查看:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
使用 records 字段 设置 OpenTime的方法
这是 records 字段的 JSON 格式范例
{
"records": [
{
"weekdays": [
0,
1,
2
],
"periods": [
{
"start": "2019-04-24T12:00Z",
"until": "2019-04-24T13:00Z"
}
]
},
{
"weekdays": [
3,
4,
5,
6
],
"periods": [
{
"start": "2019-04-24T13:00Z",
"until": "2019-04-24T14:00Z"
}
]
}
]}
1.records 字段的列表最多可以包含7个字典对象元素。 每个元素均包含代表工作日的”weekdays”字段和工作时间的”periods”字段。 警告:每个元素的weekdays字段不可以出现重复的数字。比如,一个元素的weekdays字段为{“weekdays”: [0, 1, 2]},其他元素的weekdays不可以再出现0、1或2。
2.records 字段的元素说明
Property name | Value | Description | Notes |
weekdays | list | 工作日列表。weekdays列表包含数字是代表该条开放时间记录适用到一周之中的哪几天。0 是星期天,1是星期一 1,6是星期六,如此类推。 | |
periods | list | 工作时间列表。periods列表包含的字典元素是代表该条开放时间记录的工作时间段。分别有start和until字段,start是开始时间,until是结束时间,虽然它们需要提交日期时间格式,但是实际只会使用到它们的时间部分。比如{“start”: “2019-04-24T08:00Z”, “until”: “2019-04-24T13:00Z”},这表示该条时间记录的工作时间在8点到13点。 | periods列表的元素最多可以包含3个。 |
3.注意,虽然periods字段的元素中”start”和”until”必须为日期时间格式,但是后台只需要提取里面时间点表示工作时间段,前端只需要以当天提交的日期即可。periods字段的元素最多可以包含3个。意思是可以有多个时间段。但是其他时间段之间必须符合时间顺序,不可以出现交点或包含关系情况。
Response
如果请求成功,该API返回设置后的User.OpenTime工作开放时间列表数据在响应体信息。
200 Update current user’s OpenTime data successfully
范例解释:{“weekdays”: [0, 1, 2], “start”: “2019-04-24T12:00:00Z”, “until”: “2019-04-24T13:00:00Z”},这表示在每周的星期天、星期一和星期二的12点到13点是工作开放时间。
{
"data": [
{
"start": "2019-04-24T12:00:00Z",
"until": "2019-04-24T13:00:00Z",
"timezone": "UTC",
"weekdays": [0,1,2],
"repeat_start": "2020-06-17T10:53:17Z"
},
{
"start": "2019-04-24T13:00:00Z",
"until": "2019-04-24T14:00:00Z",
"timezone": "UTC",
"weekdays": [3,4,5,6],
"repeat_start": "2020-06-17T10:53:17Z"
}
]
}
400 Validation Exception
示例返回数据可参考 API Common – Validation Exception