134[后端] iot大屏接口开发
任务描述

功能说明

覆盖全景浏览、社区安全、运营管理、监控录像的数据接口与联动逻辑。

关联任务

  • 关联设计:[设计] 小区IoT中控大屏页面设计
  • 关联前端:[前端] 小区IoT中控大屏页面开发
  • 关联测试:[测试-后端] 小区IoT中控大屏接口测试

接口1:全景数据总览

请求方式GET
请求路径/api/v1/panorama/summary
对应功能全景浏览-数据总览面板

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID全局上下文

响应字段

字段名类型说明前端用途
areanumber占地面积展示
greenRatenumber绿化率展示
housesnumber房屋总量展示
personsnumber人员总量展示
carsnumber车辆总量展示
facilitiesnumber配套设施数展示

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验communityId必填,UUID格式缺失返回400
2.权限检查校验用户对communityId访问权限角色:物业经理/安防/运营无权限403
3.数据查询查询社区信息表、房屋表、人员表、车辆表、设施表按communityId汇总无数据返回0值
4.业务处理计算绿化率、总量绿化率=绿地面积/总面积计算异常返回500
5.数据组装组装 summary 字段字段映射响应-

错误处理

错误码触发场景前端提示
400001参数缺失缺少必要参数
403001无访问权限无权限
500001内部错误服务异常

接口2:楼栋详情及模型点位

请求方式GET
请求路径/api/v1/buildings/{id}/detail
对应功能楼栋点击查看

请求参数

参数名类型必填说明前端来源
idstring楼栋ID模型点击
communityIdstring小区ID上下文

响应字段

字段名类型说明前端用途
occupancyRatenumber入住率卡片展示
houseTypesarray房屋类型分布图表
personStatsarray人员分类统计图表
carsarray登记用车信息列表
modelPositionobject模型坐标定位高亮

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验id、communityId必填,UUID400返回
2.权限检查校验楼栋访问权限角色:物业/安防403返回
3.数据查询楼栋、房屋、人员、车辆、模型表按楼栋ID关联无楼栋404
4.业务处理计算入住率、分类统计入住率=入住房屋/总房屋异常500
5.数据组装组装卡片数据+模型坐标字段映射响应-

错误处理

错误码触发场景前端提示
404001楼栋不存在数据不存在
403001无权限无权限
500002计算异常服务异常

接口3:房屋搜索定位

请求方式GET
请求路径/api/v1/houses/search
对应功能房屋搜索定位

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID上下文
keywordstring房号/楼栋/单元关键词搜索框

响应字段

字段名类型说明前端用途
houseIdstring房屋ID点击高亮
displayNamestring楼栋-单元-室号结果列表
modelPositionobject坐标定位高亮
personCarInfoobject关联人员/车辆详情弹窗

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验communityId、keywordkeyword 1-50字符400返回
2.权限检查校验查询权限允许物业/安防/客服403返回
3.数据查询房屋表模糊匹配,关联模型坐标按关键词LIKE,限制50条无数据返回空数组
4.业务处理补充关联人员车辆信息最近登记车辆、住户信息关联失败忽略
5.数据组装组装列表字段映射-

错误处理

错误码触发场景前端提示
400002keyword非法请输入有效房号
403002无权限无权限
500003查询异常服务异常

接口4:报警实时与统计

请求方式GET
请求路径/api/v1/security/alarms
对应功能社区安全-报警数据处理

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID上下文
statusstring待确认/已确认/误报筛选
pagenumber页码分页
pageSizenumber每页分页

响应字段

字段名类型说明前端用途
statsobject各状态数量统计看板
listarray报警列表待处理列表
scrollarray滚动播报最新报警滚动区域

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验分页、statuspage>=1,pageSize<=100400返回
2.权限检查校验报警查看权限安防/值班可见403返回
3.数据查询查询报警表,按时间倒序,统计状态过滤communityId查询失败500
4.业务处理滚动列表取最新100条,列表按分页状态过滤优先异常记录跳过
5.数据组装stats+list+scroll字段映射-

错误处理

错误码触发场景前端提示
400003分页非法分页参数错误
403003无权限无权限
500004查询异常服务异常

接口5:运营数据分析

请求方式GET
请求路径/api/v1/operation/analytics
对应功能运营管理-房屋/人员/车辆/工单/投诉

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID上下文
dateRangearray时间范围筛选控件

响应字段

字段名类型说明前端用途
houseOccupancyarray入住/空置趋势图表
personCompositionarray人员类型分布图表
vehicleStatsarray车辆占比图表
workOrdersarray工单分类、最新工单列表
complaintsarray投诉分类、最新投诉列表

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验communityId,dateRangedateRange最多90天超出返回400
2.权限检查校验运营数据查看权限运营分析员/经理403返回
3.数据查询房屋、人员、车辆、工单、投诉、AI分类服务按时间过滤外部调用失败记录
4.业务处理计算趋势、占比,调用AI分类缺数据填0AI失败降级不展示分类
5.数据组装组装各模块数据字段映射-

错误处理

错误码触发场景前端提示
400004时间范围非法请选择90天内时间
403004无权限无权限
500005数据查询失败服务异常

接口6:监控流列表

请求方式GET
请求路径/api/v1/monitor/streams
对应功能监控录像多画面

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID上下文
limitnumber返回流数量配置

响应字段

字段名类型说明前端用途
streamsarray流地址、类型、优先级监控画面

详细业务逻辑(必须与需求功能点对应)

步骤处理内容规则说明异常处理
1.参数校验校验communityId、limitlimit默认9,最大16非法400
2.权限检查监控查看权限安防/经理403
3.数据查询查询监控点位表、流媒体服务按优先级排序无流返回空
4.业务处理生成可播放URL,过滤离线离线标记状态离线流不返回URL
5.数据组装组装streams包含坐标、名称-

错误处理

错误码触发场景前端提示
400005参数非法参数错误
403005无权限无权限
500006流服务异常视频不可用
来源Bug
指派给
任务类型
开发
任务状态
未开始
进度
0 %
优先级
1
关键词
抄送给
由谁创建
邹鹏 于 2025-12-16 15:55:36
由谁完成
由谁取消
由谁关闭
关闭原因
最后编辑
最初预计
40 h
总计消耗
0 h
预计剩余
40 h
预计开始
实际开始
截止日期