cn.felord.reactive.api

Interface MeetingRoomApi

public interface MeetingRoomApi

会议室API

Since:

2024/11/29

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<GenericResponse<Integer>>	add(RoomCreateRequest request) 添加会议室
io.reactivex.rxjava3.core.Single<BookingResponse>	book(BookingRequest request) 预定会议室
io.reactivex.rxjava3.core.Single<BookingResultResponse>	bookByMeeting(MeetBookingRequest request) 通过会议预定会议室
io.reactivex.rxjava3.core.Single<BookingResultResponse>	bookBySchedule(ScheduleBookingRequest request) 通过日程预定会议室
io.reactivex.rxjava3.core.Single<WeComResponse>	cancelBook(CancelBookRequest request) 取消预定会议室
io.reactivex.rxjava3.core.Single<WeComResponse>	del(MeetingRoomId meetingRoomId) 删除会议室
io.reactivex.rxjava3.core.Single<WeComResponse>	edit(RoomUpdateRequest request) 编辑会议室
io.reactivex.rxjava3.core.Single<RoomBookingResponse>	getBookInfo(RoomBookingRequest request) 根据会议室预定ID查询预定详情
io.reactivex.rxjava3.core.Single<BookingInfoResponse>	getBookingInfo(BookingInfoRequest request) 查询会议室的预定信息
io.reactivex.rxjava3.core.Single<RoomListResponse>	list(RoomListRequest request) 查询会议室

Method Detail

add

@POST(value="oa/meetingroom/add")
io.reactivex.rxjava3.core.Single<GenericResponse<Integer>> add(@Body
                                                                                                 RoomCreateRequest request)

添加会议室

企业可通过此接口添加一个会议室

如果不填写range参数，则默认为全公司可用。 如果需要为会议室设置位置信息，则必须同时填写城市（city），楼宇（building）和楼层(floor)三个参数。

Parameters:

request - the request

Returns:

the generic response

list

@POST(value="oa/meetingroom/list")
io.reactivex.rxjava3.core.Single<RoomListResponse> list(@Body
                                                                                           RoomListRequest request)

查询会议室

企业可通过此接口查询满足条件的会议室

如果需要使用某个位置信息进行查询，则需要保证其上一级的位置信息已填写， 即如需使用楼宇进行过滤，则必须同时填写城市字段。

Parameters:

request - the request

Returns:

the generic response

edit

@POST(value="oa/meetingroom/edit")
io.reactivex.rxjava3.core.Single<WeComResponse> edit(@Body
                                                                                        RoomUpdateRequest request)

编辑会议室

企业可通过此接口编辑相关会议室的基本信息

注意，会议室使用范围(range)为覆盖操作，而非增量添加

如果需要修改位置信息，请同时输入城市，楼宇和楼层三个参数，已经生成的建筑，暂不支持修改经纬度。

Parameters:

request - the request

Returns:

the we com response

del

@POST(value="oa/meetingroom/del")
io.reactivex.rxjava3.core.Single<WeComResponse> del(@Body
                                                                                      MeetingRoomId meetingRoomId)

删除会议室

企业可通过此接口删除指定的会议室

Parameters:

meetingRoomId - the meeting room id

Returns:

the we com response

getBookingInfo

@POST(value="oa/meetingroom/get_booking_info")
io.reactivex.rxjava3.core.Single<BookingInfoResponse> getBookingInfo(@Body
                                                                                                                    BookingInfoRequest request)

查询会议室的预定信息

企业可通过此接口查询相关会议室在指定时间段的预定情况，如是否已被预定，预定者的userid等信息，不支持跨天查询。

如果需要根据位置信息查询，则需要保证其上一级的位置信息已填写，即如需使用楼宇进行过滤，则必须同时填写城市字段。

Parameters:

request - the request

Returns:

the booking info

book

@POST(value="oa/meetingroom/book")
io.reactivex.rxjava3.core.Single<BookingResponse> book(@Body
                                                                                          BookingRequest request)

预定会议室

企业可通过此接口预定会议室并自动关联日程。

最小预定时长为30分钟； 预定时间和结束时间会自动按30分钟取整，即如果传入的开始和结束时间戳分别对应时间为15:15和15:45，则预定时会自动取整为15:00和16:00； 此API仅可预定无需审批的会议室； 如果当前时间已经晚于预定时间，则按以下情况进行处理： 1.当前已过预定结束时间，则不允许预定 2.当前在预定开始时间15分钟内，则允许预定 3.当前已超过预定开始时间15分钟，则自动转换预定开始时间到下一个时间窗口，即增加30分钟到开始时间

Parameters:

request - the request

Returns:

the booking response

bookBySchedule

@POST(value="oa/meetingroom/book_by_schedule")
io.reactivex.rxjava3.core.Single<BookingResultResponse> bookBySchedule(@Body
                                                                                                                      ScheduleBookingRequest request)

通过日程预定会议室

企业可通过此接口为指定日程预定会议室，支持重复日程预定，仅可预定无需审批的会议室

注意：通过日程预定会议室后，该日程将不能通过更新日程接口进行编辑，而只能调用新增日程参与者与删除日程参与者接口。 如果需要更新日程的时间等字段，可以先取消会议室预定，再调用更新日程接口，之后再重新预定会议室。

Parameters:

request - the request

Returns:

the booking result response

bookByMeeting

@POST(value="oa/meetingroom/book_by_meeting")
io.reactivex.rxjava3.core.Single<BookingResultResponse> bookByMeeting(@Body
                                                                                                                    MeetBookingRequest request)

通过会议预定会议室

企业可通过此接口为指定会议预定会议室，支持重复会议预定，仅可预定无需审批的会议室

Parameters:

request - the request

Returns:

the booking result response

cancelBook

@POST(value="oa/meetingroom/cancel_book")
io.reactivex.rxjava3.core.Single<WeComResponse> cancelBook(@Body
                                                                                                     CancelBookRequest request)

取消预定会议室

企业可通过此接口取消会议室的预定

Parameters:

request - the request

Returns:

the booking result response

getBookInfo

@POST(value="oa/meetingroom/bookinfo/get")
io.reactivex.rxjava3.core.Single<RoomBookingResponse> getBookInfo(@Body
                                                                                                             RoomBookingRequest request)

根据会议室预定ID查询预定详情

企业可通过此接口根据预定id查询相关会议室的预定情况

Parameters:

request - the request

Returns:

the booking result response