Appearance
查询日程列表
基本信息
中文名: 查询日程列表
接口名: /calendar/getSchedule
所在目录: 日程
调用方式: POST(HTTPS)
发布版本 :V1.8.2
| 最低可用版本 | V1.8.2 |
|---|
请求参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| accountId | Long | 是 | 当前操作者账号ID | |
| tenantId | Long | 是 | 当前操作者租户ID |
业务请求参数
| 参数名称 | 子参数 | 说明 | 类型 | 是否必填 |
|---|---|---|---|---|
| end | 结束时间 | DateTimeDto | 是 | |
| timeStamp | 结束时间戳 | long | 是 | |
| start | 开始时间 | DateTimeDto | 是 | |
| timeStamp | 开始时间戳 | String | 是 | |
| agentType | 查询类型(默认查询MINE)<br/>参见补充说明 | String | 否 | |
| principal | 代理的人 | PrincipalUserDTO | 否 | |
| accountId | 账号 | long | 否 | |
| displayName | 代理人昵称 | String | 否 | |
| eventType | 日历事件类型<br/>参见补充说明 | String | 是 |
特别说明:
入参start和end 目前只支持按天维度查询,不支持按小时范围查询。
如果传参查的时间范围为:
start: 2022-03-29 11:00:00
end: 2022-03-29 12:00:00
实际处理逻辑会变成:
start: 2022-03-29 00:00:00
end: 2022-03-30 00:00:00
返回参数
| 名称 | 子参数 | 子参数 | 子参数 | 说明 | 类型 |
|---|---|---|---|---|---|
| success | 请求响应状态 | boolean | |||
| content | 响应内容 | Object | |||
| data | 业务响应内容 | Object | |||
| calendarId | 日程id | Long | |||
| creator | 日历创建者 | Object | |||
| accountId | 创建者id | String | |||
| end | 结束时间 | DateTimeDto | |||
| timeStamp | 结束时间戳 | long | |||
| start | 开始时间 | DateTimeDto | |||
| timeStamp | 开始时间戳 | long | |||
| event | 事件详情 | Object | |||
| location | 地点 | String | |||
| meetingStatus | 会议状态。<br/>all:所有状态的会议<br/>notStarted: 会议尚未开始<br/>inProgress: 会议正在进行<br/>cancelled:会议已经取消<br/>alreadyOver:会议已经结束 | String | |||
| subject | 主题 | String | |||
| description | 描述 | String | |||
| meetingRoom | 会议室 | String | |||
| leaders | 参会领导,多人用逗号隔开,业务方扩展。 | String | |||
| noonStatus | 参会时间段, 业务方扩展 “morning”,“noon”,“afternoon” | String | |||
| seq | 日程顺序,业务方扩展字段 | String | |||
| mergeGroupId | 日程分组,业务方扩展字段 | String | |||
| eventType | 日历事件类型,参考最下面补充说明 | String | |||
| sourceName | 日程来源应用 | String | |||
| confirmStatus | 参加状态 | String | |||
| success | 业务响应状态 | boolean | |||
| responseMessage | 业务响应描述 | String | |||
| responseCode | 业务响应标示 | String |
