120[后端] 全景浏览接口开发已删除
任务描述
0. 【前置分析】遵循现有REST风格,错误码:200成功,4xx参数/权限,5xx系统错误;统一返回{code,msg,data}

功能说明

全景总览、楼栋详情、房屋搜索、数据联动定位

关联任务

  • 关联前端任务:[前端] 中控大屏前端开发
  • 关联测试任务:[测试-后端] 全量接口测试

接口1:全景数据总览

请求方式GET
请求路径/api/v1/overview/summary

请求参数

参数名类型必填说明前端来源
communityIdnumber小区ID路由/配置

响应字段

字段名类型说明前端用途
areanumber占地面积㎡概况展示
greeningRatenumber绿化率%概况展示
houseTotalnumber房屋/户数数据跳转
personTotalnumber人员总数数据跳转
vehicleTotalnumber车辆总数数据跳转
facilityCountnumber公共设施数图标展示

业务逻辑

  1. 校验communityId
  2. 权限校验
  3. 汇总统计并返回

错误处理

错误码场景前端提示
4001参数缺失参数错误
4031无权限无权限访问

接口2:楼栋详情

请求方式GET
请求路径/api/v1/buildings/{id}

请求参数

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

响应字段

字段名类型说明前端用途
occupancyRatenumber入住率%卡片展示
houseTypeDistarray房屋类型分布图表
personDistarray人员分类统计图表
vehiclesarray登记车辆列表

业务逻辑

  1. 校验楼栋存在
  2. 权限校验
  3. 聚合分布数据

错误处理

错误码场景前端提示
4041楼栋不存在数据不存在

接口3:房屋搜索定位

请求方式GET
请求路径/api/v1/units/search

请求参数

参数名类型必填说明前端来源
keywordstring房号关键字搜索框
buildingIdnumber限定楼栋下拉

响应字段

字段名类型说明前端用途
unitIdnumber房屋ID定位参数
buildingIdnumber楼栋ID联动
labelstring房号列表展示
coordsobject模型坐标高亮定位

业务逻辑

  1. 校验keyword
  2. 模糊搜索
  3. 返回坐标

错误处理

错误码场景前端提示
4002keyword为空请输入房号

接口4:数据联动定位

请求方式GET
请求路径/api/v1/map/locate-by-entity

请求参数

参数名类型必填说明前端来源
entityTypestringbuilding/unit/device/person/vehicle面板点击
entityIdnumber实体ID面板点击

响应字段

字段名类型说明前端用途
coordsobject模型坐标定位
extraobject附加摘要信息展示

业务逻辑

  1. 校验类型与ID
  2. 查映射坐标
  3. 返回定位信息

错误处理

错误码场景前端提示
4042实体不存在无法定位
来源Bug
指派给
任务类型
开发
任务状态
未开始
进度
0 %
优先级
1
关键词
抄送给
由谁创建
邹鹏 于 2025-12-16 12:22:00
由谁完成
由谁取消
由谁关闭
关闭原因
最后编辑
最初预计
10 h
总计消耗
0 h
预计剩余
10 h
预计开始
实际开始
截止日期