140[后端] iot大屏接口开发已删除
任务描述

功能说明

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

关联任务

  • 关联设计:[设计] iot大屏页面设计
  • 关联前端:[前端] iot大屏页面开发
  • 关联测试:[测试-后端] iot大屏接口测试

接口1:全景数据总览

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

请求参数

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

响应字段

字段名类型说明前端用途
areanumber占地总面积概况卡片
greeningRatenumber绿化率概况卡片
houseTotalnumber房屋总数数据总览
peopleTotalnumber人员总数数据总览
vehicleTotalnumber车辆总数数据总览
facilitySummaryarray配套设施统计配套列表

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

步骤处理内容规则说明异常处理
1.参数校验校验communityId必填,长度1-64缺失返回400001
2.权限检查校验用户是否可访问该community角色需绑定该小区无权限返回403001
3.数据查询查社区表、房屋表、人员表、车辆表、设施表按communityId聚合无数据返回404001
4.业务处理计算绿化率、统计各总数绿化率=绿地面积/总面积异常记录日志,返回500001
5.数据组装组装指标与设施列表字段映射响应结构-

错误处理

错误码触发场景前端提示
400001参数缺失/格式错误参数错误
403001无权限暂无权限
404001社区不存在数据不存在
500001内部异常服务异常

接口2:楼栋详情

请求方式GET
请求路径/api/v1/community/buildings/{buildingId}
对应功能全景浏览-楼栋点击卡片

请求参数

参数名类型必填说明前端来源
buildingIdstring楼栋ID模型点选

响应字段

字段名类型说明前端用途
occupancyRatenumber入住率卡片展示
houseTypeDistarray房屋类型分布饼图
peopleCategoryarray人员分类统计柱状图
vehiclesarray登记用车信息列表

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

步骤处理内容规则说明异常处理
1.参数校验校验buildingId必填,UUID格式缺失/非法返回400001
2.权限检查校验用户对楼栋所属小区权限需匹配用户小区列表无权限403001
3.数据查询查楼栋、房屋、住户、车辆表通过buildingId关联无数据404001
4.业务处理计算入住率、分布统计入住率=已入住房屋/总房屋计算异常500001
5.数据组装返回统计及车辆列表格式化字段名称-

错误处理

错误码触发场景前端提示
400001参数错误参数错误
403001无权限暂无权限
404001楼栋不存在数据不存在
500001内部异常服务异常

接口3:实时报警与设备

请求方式GET
请求路径/api/v1/security/alerts
对应功能社区安全-报警数据看板、设备类型分布

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID全局上下文
statusstring待确认/已确认/误报筛选控件
limitnumber返回报警条数滚动区域

响应字段

字段名类型说明前端用途
alertStatsobject各状态数量看板数字
alertsarray报警列表滚动播报
deviceTypeDistarray设备类型分布饼图/柱状图

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

步骤处理内容规则说明异常处理
1.参数校验communityId、status、limitcommunityId必填;status枚举;limit 1-200非法返回400001
2.权限检查检查用户安防数据权限需安防或管理员角色无权限403001
3.数据查询查报警表、设备表按communityId、status过滤无数据返回空列表
4.业务处理统计各状态数量,按时间排序,计算设备类型分布状态统计聚合,设备类型分组处理异常500001
5.数据组装组装stats、列表、分布字段统一命名-

错误处理

错误码触发场景前端提示
400001参数错误参数错误
403001无权限暂无权限
500001内部异常服务异常

接口4:运营分析数据

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

请求参数

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

响应字段

字段名类型说明前端用途
houseOccupancyTrendarray入住率趋势折线图
peopleCompositionarray人员构成饼图
vehicleStatsarray车辆占比饼图
abnormalPassarray异常通行记录列表
workOrdersarray最新工单滚动列表
complaintsarray投诉分析列表
dutyRosterarray值班信息排班表

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

步骤处理内容规则说明异常处理
1.参数校验communityId、dateRangecommunityId必填;dateRange最多180天非法400001
2.权限检查运营数据权限运营/管理员角色无权限403001
3.数据查询查入住、人员、车辆、工单、投诉、值班表按communityId和时间过滤无数据返回空结构
4.业务处理计算趋势、占比、异常统计,AI投诉分类占比按总量分组,投诉调用AI服务处理异常500001
5.数据组装组装趋势、分布、列表字段对齐前端展示-

错误处理

错误码触发场景前端提示
400001参数错误参数错误
403001无权限暂无权限
500001内部异常服务异常

接口5:监控流列表

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

请求参数

参数名类型必填说明前端来源
communityIdstring小区ID全局上下文
areastring区域过滤区域选择
countnumber返回流数量多画面数量

响应字段

字段名类型说明前端用途
streamsarray流列表(id,name,url,protocol,area,isKeyPoint)播放器列表

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

步骤处理内容规则说明异常处理
1.参数校验communityId、area、countcommunityId必填;count 1-16非法400001
2.权限检查视频查看权限安防/管理员无权限403001
3.数据查询查摄像头表或视频平台按communityId、area过滤,按重点区域优先无数据返回空列表
4.业务处理组装播放地址与鉴权token协议HLS/RTC按配置取token失败500002
5.数据组装返回streams数组字段统一-

错误处理

错误码触发场景前端提示
400001参数错误参数错误
403001无权限暂无权限
500002鉴权失败获取播放地址失败
500001内部异常服务异常
来源Bug
指派给
任务类型
开发
任务状态
未开始
进度
0 %
优先级
1
关键词
抄送给
由谁创建
邹鹏 于 2025-12-16 17:14:30
由谁完成
由谁取消
由谁关闭
关闭原因
最后编辑
最初预计
28 h
总计消耗
0 h
预计剩余
28 h
预计开始
实际开始
截止日期