小區管理
小區是上面所有接口調用和資源創建的基礎，所有設備、人臉、通行記錄等數據都是捆綁在小區下面。
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 | 更新時間 |