API 接口文档：添加小区
添加小区
修改小区
删除小区
查询小区
1. 接口名称
添加小区
2. 接口描述
该接口主要用于外部系统添加小区信息，包括小区基本信息、地理位置、收费信息等，并自动创建相关业务流程（如投诉建议流程、物品调拨流程）。
3. 接口路径
http://{ip}:{port}/app/community.saveCommunity
4. 请求方法
POST
5. 请求头
| 参数名称 |
必填 |
类型 |
描述 |
Authorization |
是 |
String |
用户认证 Token（Base Token） |
app-id |
是 |
String |
应用 ID（由系统分配） |
transaction-id |
是 |
String |
请求流水号（格式：1000000000+YYYYMMDDhhmmss+6位序列） |
sign |
是 |
String |
签名 |
req-time |
是 |
String |
请求时间（格式：YYYYMMDDhhmmss） |
6. 请求参数（Body - JSON）
6.1 必填参数
| 参数名称 |
类型 |
描述 |
示例 |
name |
String |
小区名称 |
"api接口小区" |
address |
String |
小区详细地址 |
"天津省天津市和平区api接口小区" |
cityCode |
String |
地区编码 |
"120101" |
payFeeMonth |
int |
小区收费周期（月） |
12 |
feePrice |
int |
小区收费价格（单位：分/元） |
0 |
6.2 可选参数
| 参数名称 |
类型 |
描述 |
示例 |
mapX |
String |
经度 |
"101.33" |
mapY |
String |
纬度 |
"101.33" |
nearbyLandmarks |
String |
附近地标 |
"xx公园旁" |
tel |
String |
小区客服电话 |
"18909711443" |
attrs |
JSONArray |
自定义属性（见下方说明） |
[{"specCd": "9329000004", "value": "123123"}] |
6.3 attrs 结构说明
用于扩展小区属性，如社区编码等。
| 参数名称 |
类型 |
描述 |
示例 |
specCd |
String |
属性编码 |
"9329000004" |
value |
String |
属性值 |
"123123" |
7. 返回值
| 参数名称 |
类型 |
描述 |
示例 |
code |
int |
返回码（0 成功，非 0 失败） |
0 |
msg |
String |
返回信息 |
"成功" |
data |
String |
小区ID |
"10202210000001" |
8. 示例请求
POST /app/community.saveCommunity
Headers:
{
"Authorization": "Bearer xxxxx",
"app-id": "micro-community",
"transaction-id": "100000000020221001123456000001",
"sign": "xxxxx",
"req-time": "20221001123456"
}
Body:
{
"name": "api接口小区",
"address": "天津省天津市和平区api接口小区",
"cityCode": "120101",
"mapX": "101.33",
"mapY": "101.33",
"nearbyLandmarks": "23",
"tel": "18909711443",
"payFeeMonth": 12,
"feePrice": 0,
"attrs": [
{
"specCd": "9329000004",
"value": "123123"
}
]
}
9. 示例响应
{
"code": 0,
"msg": "成功",
"data": "10202210000001"
}
10. 业务逻辑说明
- 校验参数：检查必填字段（
name、address、cityCode 等）。
- 保存小区：写入小区基本信息到数据库。
- 初始化业务流程：自动创建默认的投诉建议流程和物品调拨流程。
- 处理扩展属性：如果存在
attrs，写入自定义属性。
11. 注意事项
feePrice 单位为分（如 100 表示 1 元）。 attrs 需符合系统预定义的属性编码（如 specCd）。 - 接口为事务操作，任一步骤失败会回滚所有操作。
