全部产品

小区管理

更新时间:2020-10-13 11:39:09

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

1.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

1.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

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

返回结果

参数名

参数描述

数据类型

data

JSON

小区信息

小区信息

参数名

参数描述

数据类型

communityId

Long

小区id

1.4 删除小区

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

该接口不需要cloudtoken

接口

版本

描述

/solution/community/paas/community/delete

1.0.0

删除小区

请求参数

字段名

类型

必填

备注

communityId

Long

小区id

返回结果

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

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

该接口不需要cloudtoken

接口

版本

描述

/solution/community/paas/community/detail/get

1.0.1

获取小区详情

请求参数

字段名

类型

必填

备注

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

1.6 根据设备查询小区信息

接口

版本

描述

/solution/community/paas/device/community/get

1.0.1

根据项目Id获取

请求参数

字段名

类型

必填

备注

deviceIdentity

JsonObject

详见DeviceIdentityDTO

DeviceIdentityDTO

字段名

类型

必填

备注

type

String

IOT_ID/PK_AND_DN

iotId

String

设备id

productKey

String

产品PK

deviceName

String

产品DN

返回结果

参数名

参数描述

数据类型

data

返回值

JsonArray详见 CommunityDetailDTO

1.7 小区审核

审核创建新小区的申请。该接口不需要cloudtoken

Path路径

/solution/community/paas/community/verify

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

communityId

Long

小区Id

status

Integer

审核状态:1通过;2不通过

返回参数

参数

类型

描述