全部产品
云市场

小区管理

更新时间:2020-03-24 20:28:08

小区是上面所有接口调用和资源创建的基础,所有设备、人脸、通行记录等数据都是捆绑在小区下面。

1获取POID列表

POID是高德标记每一个已存在小区的唯一id,为了后续数据能够和高德侧发生较好的关联,目前创建小区需要对应的POID信息

接口 版本 描述
/solution/community/paas/poid/query 1.0.0 获取小区piod列表

请求参数

字段名 类型 必填 备注
keywords String 关键词
city String 城市
citylimit Boolean 仅返回指定城市数据
pageSize Integer 每页记录数据
pageNo Integer 当前页

返回结果

参数名 参数描述 数据类型
code 错误码 Int
message 错误信息 String
data 返回值 JsonArray

2获取小区列表

获取当前租户下的有权限的小区列表

接口 版本 描述
/solution/community/paas/community/query 1.0.0 获取小区列表

请求参数

字段名 类型 必填 备注
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

3创建小区【需审核】

通过高德poid来创建小区,这个过程并非一定要系统完成,也可以让阿里云IoT后台小二帮忙创建(客户提供相关材料)
注意:certificate需要使用1.4.6获取OSS地址并上传

接口 版本 描述
/solution/community/paas/community/apply 1.0.0 创建小区

请求参数

字段名 类型 必填 备注
poid String 小区poid
name String 小区名称
address String 小区地址
serviceStartTime String 服务起始时间
serviceEndTime String 服务终止时间
certificate String 证书地址(OSS or 安全url校验)

返回结果

参数名 参数描述 数据类型
data JSON 小区信息

小区信息

参数名 参数描述 数据类型
communityId Long 小区id

4删除小区

只允许删除申请失败的小区,不支持删除已经审批通过的小区

接口 版本 描述
/solution/community/paas/community/delete 1.0.0 删除小区

请求参数

字段名 类型 必填 备注
communityId Long 小区id

返回结果

通用网关消息体,无业务字段

5查询小区信息【包括审核状态】

接口 版本 描述
/solution/community/paas/community/detail/get 1.0.0 获取小区详情

请求参数

字段名 类型 必填 备注
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

6根据设备查询小区信息

接口 版本 描述
/solution/community/paas/device/community/get
1.0.0 根据项目Id获取

请求参数

字段名 类型 必填 备注
deviceIdentity
JsonObject 详见DeviceIdentityDTO


DeviceIdentityDTO

字段名 类型 必填 备注
type String IOT_ID/PK_AND_DN
iotId String 设备id
productKey String 产品PK
deviceName String 产品DN

返回结果

参数名 参数描述 数据类型
data 返回值 JsonArray详见 CommunityDetailDTO