HC小区接口文档

保存停车位

查询车位
删除车位
修改车位
添加车位

1. 保存停车位信息接口

1.1 接口描述

该接口用于创建新的停车位信息,支持普通车位和子母车位的创建。如果是子母车位,会自动创建母子车位关联关系。

1.2 接口路径

serviceCode: parkingSpace.saveParkingSpace

1.3 请求方法

POST

1.4 请求头参数

参数名称 必填 类型 描述
Authorization String 用户认证token
app-id String 应用ID
transaction-id String 请求流水号
sign String 签名
req-time String 请求时间(YYYYMMDDhhmmss)

1.5 请求参数

请求体参数(JSON格式)
参数名称 必填 类型 描述 示例
communityId String 小区ID "123456789"
num String 车位编号 "A001"
area Number 车位面积(平方米) 12.5
userId String 操作人用户ID "user123"
paId String 停车场ID "park001"
parkingType String 车位类型(默认普通车位,子母车位需传"1001") "1001"
remark String 备注信息 "VIP专用车位"

1.6 返回值

响应体格式(JSON)
参数名称 类型 描述
code String 返回码(0-成功)
msg String 返回信息
data Object 返回数据
data对象结构
参数名称 类型 描述
psId String 生成的车位ID
bId String 业务ID(固定为"-1")

1.7 业务逻辑说明

  1. 验证必填参数完整性
  2. 生成车位唯一ID(psId)和业务ID(bId)
  3. 设置车位默认状态为"F"(空闲)
  4. 保存车位信息到数据库
  5. 如果是子母车位(parkingType="1001"),自动创建关联子车位(在原车位编号后加"M")

1.8 示例请求

POST /api/parkingSpace/save
Headers:
{
  "Authorization": "Bearer xxxxxx",
  "app-id": "community-service",
  "transaction-id": "100000000020220101120000000001",
  "sign": "xxxxxx",
  "req-time": "20220101120000"
}

Body:
{
  "communityId": "123456789",
  "num": "A001",
  "area": 12.5,
  "userId": "user123",
  "paId": "park001",
  "parkingType": "1001",
  "remark": "VIP专用车位"
}

1.9 示例响应

{
  "code": "0",
  "msg": "成功",
  "data": {
    "psId": "PS202201010001",
    "bId": "-1"
  }
}

1.10 错误码说明

错误码 描述
1001 缺少必要参数
1002 小区ID不能为空
1003 车位编号不能为空
1004 车位面积不能为空
1005 用户ID不能为空
1006 停车场ID不能为空
2001 保存车位信息失败

1.11 注意事项

  1. 子母车位会自动创建两个车位记录,主车位编号为原编号,子车位编号为原编号+"M"
  2. 车位初始状态默认为"F"(空闲)
  3. 创建时间由系统自动生成
  4. 业务ID(bId)固定为"-1"