小区管理
小区是上面所有接口调用和资源创建的基础，所有设备、人脸、通行记录等数据都是捆绑在小区下面。
1.1 获取POID列表
POID是高德标记每一个已存在小区的唯一ID，为了后续数据能够和高德侧发生较好的关联，目前创建小区需要对应的POID信息
接口 | 版本 | 描述 |
/solution/community/paas/poid/query | 1.0.1 | 获取小区piod列表 |
请求参数
字段名 | 类型 | 必填 | 备注 |
keywords | String | 是 | 关键词 |
city | String | 是 | 城市 |
citylimit | Boolean | 否 | 仅返回指定城市数据 |
pageSize | Integer | 否 | 每页记录数据 |
pageNo | Integer | 否 | 当前页 |
返回结果
参数名 | 参数描述 | 数据类型 |
code | 错误码 | Int |
message | 错误信息 | String |
data | 返回值 | JsonArray |
1.2 获取小区列表
获取当前租户下的有权限的小区列表
接口 | 版本 | 描述 |
/solution/community/paas/community/query | 1.0.2 | 获取小区列表 |
请求参数
字段名 | 类型 | 必填 | 备注 |
projectId | String | 否 | 按照项目ID搜索 |
applyStatus | String | 否 | 审批状态 1审批中 2已审批 3拒绝 |
pageSize | Integer | 否 | 每页记录数据默认20 |
pageNo | Integer | 否 | 当前页默认1 |
返回结果
参数名 | 参数描述 | 数据类型 |
data | 返回值 | JsonArray 详见 CommunityInfoDTO |
CommunityInfoDTO
字段名 | 类型 | 备注 |
communityId | Long | 小区ID |
name | String | 名称 |
applyStatus | Integer | 状态：审核中/已审批 |
projectId | String | 小区对应项目ID |
gmtCreate | Long | 创建时间 |
poiCode | String |
1.3 创建小区【需审核】
通过高德poid来创建小区，这个过程并非一定要系统完成，也可以让阿里云IoT后台小二帮忙创建（客户提供相关材料）
注意：certificate需要使用1.4.6获取OSS地址并上传
该接口不需要cloudtoken
接口 | 版本 | 描述 |
/solution/community/paas/community/apply | 1.0.3 | 创建小区 |
请求参数
字段名 | 类型 | 必填 | 备注 |
poid | String | 是 | 小区poid |
name | String | 是 | 小区名称 |
address | String | 是 | 小区地址 |
serviceStartTime | String | 是 | 服务起始时间 |
serviceEndTime | String | 是 | 服务终止时间 |
certificateUploadId | String | 是 | 证书地址文件上传ID（OSS or 安全URL校验）。获取uploadId见“获取OSS上传地址”和“保存上传OSS文件”接口。 上传bizCode=COMMUNITY_FILE |
certificateUploadId2 | String | 否 | 证书地址2 |
certificateUploadId3 | String | 否 | 证书地址3 |
返回结果
参数名 | 参数描述 | 数据类型 |
data | JSON | 小区信息 |
小区信息
参数名 | 参数描述 | 数据类型 |
communityId | Long | 小区ID |
1.4 删除小区
只允许删除申请失败的小区，不支持删除已经审批通过的小区
该接口不需要cloudtoken
接口 | 版本 | 描述 |
/solution/community/paas/community/delete | 1.0.1 | 删除小区 |
请求参数
字段名 | 类型 | 必填 | 备注 |
communityId | Long | 是 | 小区ID |
返回结果
通用网关消息体，无业务字段
1.5 查询小区信息【包括审核状态】
该接口不需要cloudtoken
接口 | 版本 | 描述 |
/solution/community/paas/community/detail/get | 1.0.3 | 获取小区详情 |
请求参数
字段名 | 类型 | 必填 | 备注 |
communityId | Long | 是 | 小区ID |
返回结果
参数名 | 参数描述 | 数据类型 |
data | 返回值 | JsonArray详见 CommunityDetailDTO |
CommunityDetailDTO
字段名 | 类型 | 备注 |
communityId | Long | 小区ID |
name | String | 名称 |
applyStatus | Integer | 状态：审核中/已审批 |
address | String | 小区省份 |
serviceStartTime | Date | 服务开始时间 |
serviceEndTime | Date | 服务终止时间 |
poiCode | String | poid |
spaceId | String | 小区根空间ID |
projectId | String | 项目ID |
gmtCreate | Long | 创建时间 |
gmtModified | Long | 更新时间 |
1.6 根据设备查询小区信息
接口 | 版本 | 描述 |
/solution/community/paas/device/community/get | 1.0.3 | 根据项目ID获取 |
请求参数
字段名 | 类型 | 必填 | 备注 |
deviceIdentity | JsonObject | 是 | 详见DeviceIdentityDTO |
DeviceIdentityDTO
字段名 | 类型 | 必填 | 备注 |
type | String | 是 | IOT_ID/PK_AND_DN |
iotId | String | 否 | 设备ID |
productKey | String | 否 | 产品PK |
deviceName | String | 否 | 产品DN |
返回结果
参数名 | 参数描述 | 数据类型 |
data | 返回值 | JsonObject如下 |
CommunityDetailDTO
字段名 | 类型 | 备注 |
communityId | Long | 小区ID |
name | String | 名称 |
imgOssUrl | String | 小区证明文件 |
applyStatus | Integer | 状态：审核中/已审批 |
address | String | 小区省份 |
serviceStartTime | Date | 服务开始时间 |
serviceEndTime | Date | 服务终止时间 |
poiCode | String | poid |
spaceId | String | 空间ID |
spaceType | String | 空间类型 |
projectId | String | 项目ID |
gmtCreate | Long | 创建时间 |
gmtModified | Long | 更新时间 |