获取会议室列表
用于搜索会议室,支持会议室名称、地址、多容纳人、多地点、多配套设备、指定部门、会议室预约状态搜索 每次查询最多返回200条数据
请求参数:
注意:
1,接口返回的预约数据以预约的开始时间(startTimeFilter)当天的数据,如果开始时间为空则返回系统当天的数据
2,预约状态查找,必须传递有效的开始时间(startTimeFilter)和结束时间(endTimeFilter),否则状态查询失效
| Parameters | Type/Value | Require | Description |
|---|---|---|---|
| page | [int] | 否 | 页标,起始值、默认值为1 |
| size | [int] | 否 | 每页数量,默认20,最大支持200 |
| nameFilter | [string] | 否 | 查询全拼、简拼、会议室名称 |
| capacityFilter | [string] | 否 | 多容纳人数查询,字典id,以英文逗号,分开 |
| locusFilter | [string] | 否 | 多会议室地点,字典id,以英文逗号,分开 |
| equipmentFilter | [string] | 否 | 多会议室配套查询,字典id,以英文逗号,分开 |
| groupFilter | [string] | 否 | 分组查询,字典id |
| deptFilter | [string] | 否 | 部门ID |
| statusFilter | [enum] | 否 | 会议室预约状态, ALL:全部, AVAILABLE:空闲的, SCHEDULED:已被预约的 |
| startTimeFilter | [timeStamp] | 否 | 预约状态判断的开始时间,时间戳 |
| endTimeFilter | [timeStamp] | 否 | 预约状态判断的结束时间,时间戳 |
| sort | [string] | 否 | 排序字段,以键值对方式传参,多字段排序以英文分号;隔开,例 nameFullPinYin:DESC;crreateTime:ASC |
请求例子:
- 通过CDN方式引入使用
<script src="https://cdn.jsdelivr.net/npm/umeet-js-sdk@1.0.16/UmeetJsSdk.min.js" type="text/javascript"></script> <script type="text/javascript"> // 获取会议室列表 function getRooms() { let params = { page: 1, size: 20, sort: 'nameFullPinYin:ASC', nameFilter: '', capacityFilter: '', locusFilter: '', equipmentFilter: '', groupFilter: '', statusFilter: 'ALL', startTimeFilter: new Date().getTime(), endTimeFilter: new Date().getTime() + 60 * 60 * 1000 }; UmeetJsSdk.getRooms(params, function (res) { if (res.status === 200) { roomsList = res.data.content; } else { console.log(res.data.message) } }) } </script> - 通过NPM引入使用
import UmeetJsSdk from 'umeet-js-sdk'; // 获取会议室列表 getRooms () { let that = this; let params = { page: 1, size: 20, sort: 'nameFullPinYin:ASC', nameFilter: '', capacityFilter: '', locusFilter: '', equipmentFilter: '', groupFilter: '', statusFilter: 'ALL', startTimeFilter: new Date().getTime(), endTimeFilter: new Date().getTime() + 60 * 60 * 1000 }; UmeetJsSdk.getRooms(params).then(res => { if (res.status === 200) { that.roomsList = res.data.content; } else { console.log(res.data.message) } }) }
响应结果:
请求成功时,http status code =200,响应体内容如下:
| Parameters | Type/Value | Description |
|---|---|---|
| id | [string] | 会议室主键 |
| name | [string] | 会议室名称 |
| deptId | [string] | 所属机构ID |
| deptName | [string] | 所属机构名称 |
| picture | [string] | 会议室预览图,图片路径 |
| capacityId | [string] | 容纳人数,字典id(数据字典ROOM_CAPACITY) |
| capacityName | [string] | 容纳人数,根据浏览器语言动态显示中文/英文名称(数据字典ROOM_CAPACITY) |
| typeId | [string] | 会议室类型,字典id(数据字段ROOM_TYPE) |
| typeName | [string] | 会议室类型,根据浏览器语言动态显示中文/英文名称(数据字段ROOM_TYPE) |
| layoutId | [string] | 会议室布局,字典id(数据字段ROOM_LAYOUT) |
| layoutName | [string] | 会议室布局,根据浏览器语言动态显示中文/英文名称(数据字段ROOM_LAYOUT) |
| locusId | [string] | 会议室地点,字典id(数据字段ROOM_LOCUS) |
| locusName | [string] | 会议室地点,根据浏览器语言动态显示中文/英文名称(数据字段ROOM_LOCUS) |
| groupId | [string] | 会议室分组,字典id(数据字典ROOM_GROUP) |
| groupName | [string] | 会议室分组,根据浏览器语言动态显示中文/英文名称(数据字典ROOM_GROUP) |
| managerId | [string] | 会议室管理员id |
| managerName | [string] | 会议室管理员名称 |
| equipmentIds | [array] | 会议室配套,字典id列表(数据字典ROOM_EQUIPMENT) |
| equipmentNames | [array] | 会议室配套,根据浏览器语言动态显示中文/英文名称(数据字典ROOM_EQUIPMENT) |
| roomBindInfo | [object] | 会议室绑定信息 |
| scheduleStatus | [boolean] | 根据查询条件中的开始/结束时间范围判断是否有预约的数据, true:已预约 ,false:空闲 |
| scheduleList | [array] | 查询startTimeFilter一天的预约数据,默认当天 |
roomBindInfo object:
| Parameters | Type/Value | Description |
|---|---|---|
| terminalIds | [array] | 终端id列表 |
| terminalNames | [array] | 终端名称列表 |
| informationScreenIds | [array] | 信息屏id列表 |
| informationScreenNames | [array] | 信息屏名称列表 |
| utouchIds | [array] | 门屏id列表 |
| utouchNames | [array] | 门屏名称列表 |
| detectorSensorIds | [array] | 热感传感器ID列表 |
| entranceGuard | [object] | 门禁主机和防区 |
| id | [string] | 主机id |
| name | [string] | 主机名称 |
| probeZones | [array] | 防区号, 例:[1,2,3,4] |
scheduleList array:
| Parameters | Type/Value | Description |
|---|---|---|
| id | [string] | 预约信息主键 |
| name | [string] | 预约名称 |
| roomId | [string] | 会议室名称 |
| startTime | [timestamp] | 预约的开始时间 |
| endTime | [timestamp] | 预约的结束时间 |
| type | [enum] | 预约类型 PERSONAL(个人预约), DEPARTMENTAL(部门预约),MEETING(会议室预约) |
| businessId | [string] | 业务主键 |
| remark | [string] | 备注 |
如:
{
status: 200,
data: {
"totalElements": 1,
"content": [
{
addressId: "2c91808a712ac38201712b1dad630067",
addressName: null,
capacityId: "ff808081713e500501713e756ab8004b",
capacityName: "5-10",
delFlag: false,
deptId: "cf0ae69e-9a40-4638-b38b-875f74558733",
deptLevelIds: [],
deptLevelNames: [],
deptName: "总公司",
enable: true,
equipmentIds: ["2c91808a712ac38201712b06c3e00027"],
equipmentNames: ["纸巾"],
groupId: null,
groupName: null,
id: "ff808081713e500501713e78205a0057",
layoutId: "2c91808a712ac38201712b08176b002e",
layoutName: "方形",
locusId: "2c91808a712ac38201712b07c96c002c",
locusName: null,
managerId: null,
managerName: null,
name: "000",
picture: null,
roomAssociationInfo: null,
roomBindInfo: {terminalIds: [], terminalNames: [], detectorSensorIds: [], entranceGuard: null},
scheduleList: [],
scheduleStatus: false,
scheduleUrl: null,
typeId: "2c91808a712ac38201712b0631950021",
typeName: "本地会议室"
}
],
"totalPages": 1
}
}
请求失败时,http status code = 500,响应体内容如下:
| Parameters | Type/Value | Description |
|---|---|---|
| timestamp | [string] | 错误发生日期 |
| errorCode | [string] | 错误码 |
| message | [string] | 错误信息描述 |