修改停车位接口文档
一、接口名称
修改停车位信息
二、接口描述
用于外部系统修改停车位的基本信息，包括停车位编号、关联监控设备等信息。
三、接口路径
http://{ip}:{port}/iot/api/parkingSpace.updateParkingSpace
四、请求方法
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 请求体参数(JSON格式)
| 参数名称 |
必填 |
类型 |
长度 |
描述 |
示例值 |
| psId |
是 |
String |
64 |
停车位ID |
"22" |
| communityId |
是 |
String |
30 |
小区ID |
"2022081539020475" |
| num |
否 |
String |
64 |
停车位编号 |
"22" |
| monitorId |
否 |
String |
- |
关联监控设备ID(传"-1"表示不关联) |
"123" |
七、返回值
7.1 返回值结构
| 参数名称 |
类型 |
长度 |
描述 |
示例值 |
| code |
int |
11 |
返回码，0表示成功，其他表示失败 |
0 |
| msg |
String |
250 |
返回信息 |
"成功" |
八、业务逻辑说明
- 参数校验：必填参数psId和communityId不能为空
- 如果传入了monitorId且不为"-1"，则校验监控设备是否存在
- 更新停车位信息到数据库
- 返回操作结果
九、数据库操作
- 查询监控设备信息(当传入monitorId时)
- 更新parking_space表记录
十、示例请求
POST /iot/api/parkingSpace.updateParkingSpace
Content-Type: application/json
{
"num": "22",
"psId": "22",
"communityId": "2022081539020475",
"monitorId": "123"
}
十一、示例响应
{
"code": 0,
"msg": "成功"
}
十二、错误码说明
| 错误码 |
错误描述 |
解决方案 |
| 非0值 |
更新数据失败 |
检查参数是否正确，停车位是否存在 |
| - |
监控设备不存在 |
检查monitorId是否正确 |
