查询业主车辆信息接口文档
一、接口名称
查询业主车辆信息
二、接口描述
该接口用于查询小区内业主的车辆信息，包括车辆基本信息、关联的车位信息和房屋信息。
三、接口路径
http://ip:port/iot/api/ownerCar.queryOwnerCars
四、请求方法
GET
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token Base token 通过登录接口获取token |
| app-id | 是 | String | 应用ID 系统dev账户分配 |
| transaction-id | 是 | String | 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间 YYYYMMDDhhmmss |
六、请求参数
6.1 查询参数
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| page | 是 | Integer | 当前页码 |
| row | 是 | Integer | 每页记录数 |
| communityId | 是 | String | 小区ID |
| num | 否 | String | 车位编号（可选） |
| areaNum | 否 | String | 车位区域编号（可选，与num配合使用） |
| carTypeCds | 否 | String | 车辆类型编码，多个用逗号分隔（可选） |
| psId | 否 | String | 车位ID（可选） |
| ownerId | 否 | String | 业主ID（可选） |
| carNum | 否 | String | 车牌号（可选） |
七、返回值
7.1 响应格式
{
"code": 0,
"msg": "成功",
"data": {
"total": 10,
"records": 1,
"rows": [
{
"carId": "车辆ID",
"carNum": "车牌号",
"carBrand": "车辆品牌",
"carType": "车辆类型",
"carTypeCd": "车辆类型编码",
"psId": "车位ID",
"ownerId": "业主ID",
"ownerName": "业主姓名",
"tel": "联系电话",
"communityId": "小区ID",
"state": "状态",
"stateName": "状态名称",
"bId": "业务ID",
"areaNum": "区域编号",
"paNum": "停车场编号",
"num": "车位编号",
"paId": "停车场ID",
"parkingType": "车位类型",
"roomName": "房屋信息"
}
]
}
}
7.2 状态码说明
| 状态码 | 描述 |
|---|---|
| 0 | 成功 |
| 1 | 失败 |
八、示例请求
GET /iot/api/ownerCar.queryOwnerCars?page=1&row=10&communityId=123456789&carNum=京A12345
Authorization: Bearer xxxxxxx
app-id: xxxxxxx
transaction-id: 100000000020220101120000000001
sign: xxxxxxx
req-time: 20220101120000
九、示例响应
{
"code": 0,
"msg": "成功",
"data": {
"total": 1,
"records": 1,
"rows": [
{
"carId": "1001",
"carNum": "京A12345",
"carBrand": "宝马",
"carType": "小型汽车",
"carTypeCd": "1001",
"psId": "2001",
"ownerId": "3001",
"ownerName": "张三",
"tel": "13800138000",
"communityId": "123456789",
"state": "0",
"stateName": "正常",
"bId": "4001",
"areaNum": "A区",
"paNum": "P01",
"num": "A001",
"paId": "5001",
"parkingType": "1",
"roomName": "1栋1单元101室"
}
]
}
}
十、业务逻辑说明
参数验证：
- 验证page、row和communityId参数必填且为有效数字
- 验证其他参数格式有效性
查询逻辑：
- 如果传入了车位编号(num)，先查询车位信息获取psId
- 根据查询条件查询业主车辆信息
- 当每页记录数小于20时，补充车位信息和房屋信息
- 计算总页数和总记录数
数据补充：
- 补充车位信息：包括区域编号、停车场编号、车位编号等
- 补充房屋信息：格式化为"栋-单元-室"的格式
分页处理：
- 根据page和row参数进行分页查询
- 返回总记录数和分页信息
十一、注意事项
- 必须传入小区ID(communityId)才能查询
- 当每页记录数大于等于20时，不会返回车位和房屋的详细信息
- 房屋信息最多显示3条，以"/"分隔
- 车牌号查询支持模糊匹配