停车位管理接口文档
一、接口名称
添加停车位
二、接口描述
用于外系统添加停车位功能
三、接口路径
http://{ip}:{port}/iot/api/parkingSpace.saveParkingSpace
四、请求方法
POST
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| 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 请求体参数
| 参数名称 | 必填 | 类型 | 长度 | 描述 |
|---|---|---|---|---|
| communityId | 是 | String | 30 | 小区ID |
| num | 是 | String | 64 | 停车位编号 |
| paId | 是 | String | - | 停车场ID |
| state | 是 | String | - | 停车位状态 |
| parkingType | 是 | String | - | 停车位类型 |
| monitorId | 否 | String | - | 监控设备ID(可选，不传或传"-1"表示不关联监控设备) |
七、返回值
7.1 返回值结构
| 参数名称 | 类型 | 长度 | 默认值 | 描述 |
|---|---|---|---|---|
| code | int | 11 | 0 | 返回编号，0 成功 其他失败 |
| msg | String | 250 | "成功" | 描述信息 |
八、示例请求
{
"num": "22",
"communityId": "2022081539020475",
"paId": "123456789",
"state": "1",
"parkingType": "1",
"monitorId": "1001"
}
九、示例响应
{
"code": 0,
"msg": "成功"
}
十、业务逻辑说明
参数验证：
- 验证必填参数(communityId, num, paId, state, parkingType)是否存在
- 如果传入了monitorId且不为"-1"，则验证该监控设备是否存在
数据处理：
- 生成停车位唯一ID(psId)
- 如果关联了监控设备，会记录监控设备名称
数据库操作：
- 将停车位信息保存到数据库
- 使用事务确保数据一致性
错误处理：
- 如果监控设备不存在，返回错误
- 如果保存数据失败，抛出异常
十一、注意事项
- 所有请求都需要携带正确的请求头信息
- monitorId参数可选，不传或传"-1"表示不关联监控设备
- 接口采用事务处理，确保数据一致性
- 停车位ID(psId)由系统自动生成，前缀为"10"