居民管理
1.1 新增房屋成員
Path路徑 | /solution/community/paas/house/member/save |
請求方式 | post |
接口版本 | 1.0.5 |
請求參數
參數 | 類型 | 必填 | 描述 |
communityId | Long | 否 | 小區ID |
houseSpaceId | String | 是 | 房屋空間的spaceId 要求房屋空間的typeCode為house類型 |
type | Integer | 是 | 成員類型: 1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
name | String | 是 | 姓名,更新時不允許修改 |
sex | Integer | 否 | 性別:1 男,2 女,更新時不允許修改 |
idNum | String | 否 | 身份證號 |
phoneNum | String | 否 | 手機號 |
faceImgUploadId | String | 否 | 智能識別照片上傳文件ID,見“獲取OSS上傳地址”和“保存上傳OSS文件”接口 上傳bizCode=HOUSEHOLD_FACE |
age | Integer | 否 | 年齡 |
degree | Integer | 否 | 學歷:0無; 1小學;2初中;3職高;4普高;5中專;6大專;7本科;8碩士;9博士 |
health | String | 否 | 健康狀態 |
marriage | Integer | 否 | 婚姻情況:0未婚; 1已婚; 2離異 |
politics | Integer | 否 | 政治面貌:0群眾;1黨員;2預備黨員;3積極分子;4入黨申請人;5 民主黨派 |
company | String | 否 | 工作單位 |
registry | String | 否 | 籍貫 |
residenceAddress | String | 否 | 戶籍所在地 |
registryCode | String | 否 | 籍貫編碼 |
residenceAddressCode | String | 否 | 戶籍所在地編碼 |
nationality | String | 否 | 國家/地區 |
ext | String | 否 | 自定義配置信息 |
返回參數
參數 | 類型 | 描述 |
identityId | String | 用戶ID |
1.2 修改房屋成員
Path路徑 | /solution/community/paas/house/member/save |
請求方式 | post |
接口版本 | 1.0.5 |
請求參數
參數 | 類型 | 必填 | 描述 |
houseSpaceId | String | 是 | 房屋空間 |
identityId | String | 是 | 更新成員信息 |
type | Integer | 否 | 成員類型: 1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
idNum | String | 否 | 身份證號,更新時可選 |
faceImgUploadId | String | 否 | 智能識別照片上傳文件ID,見“獲取OSS上傳地址”和“保存上傳OSS文件”接口 上傳bizCode=HOUSEHOLD_FACE |
age | Integer | 否 | 年齡 |
degree | Integer | 否 | 學歷:0無; 1小學;2初中;3職高;4普高;5中專;6大專;7本科;8碩士;9博士 |
health | String | 否 | 健康狀態 |
marriage | Integer | 否 | 婚姻情況:0未婚; 1已婚; 2離異 |
politics | Integer | 否 | 政治面貌:0群眾;1黨員;2預備黨員;3積極分子;4入黨申請人;5 民主黨派 |
company | String | 否 | 工作單位 |
registry | String | 否 | 籍貫 |
residenceAddress | String | 否 | 戶籍所在地 |
registryCode | String | 否 | 籍貫編碼 |
residenceAddressCode | String | 否 | 戶籍所在地編碼 |
nationality | String | 否 | 國家/地區 |
ext | String | 否 | 自定義配置信息 |
返回參數
參數 | 類型 | 描述 |
identityId | String | 用戶ID |
1.3 刪除房屋成員
Path路徑 | /solution/community/paas/house/member/delete |
請求方式 | post |
接口版本 | 2.0.0 |
請求參數
參數 | 類型 | 必填 | 描述 |
houseSpaceId | String | 是 | 房屋空間 |
identityId | String | 是 | 要刪除的房屋成員 如果發起用戶是業主,可以刪除其它房屋成員; 如果不是業主,只能刪除自己在房屋中的關系。 |
返回參數
參數 | 類型 | 描述 |
無 |
1.4 查詢房屋成員
Path路徑 | /solution/community/paas/house/member/list |
請求方式 | post |
接口版本 | 3.0.3 |
請求參數
參數 | 類型 | 必填 | 描述 |
houseSpaceId | String | 是 | 房屋空間 |
identityId | String | 否 | 用戶ID |
communityId | String | 否 | 小區ID |
types | JSONArray<Integer> | 否 | 成員類型:1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
返回參數
JSONArray
參數 | 類型 | 描述 |
identityId | String | 用戶ID |
type | Integer | 關系: 1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
alipayUid | String | 支付寶用戶ID |
userName | String | 姓名 |
sex | Integer | 性別:1男 2女 |
idNo | String | 身份證號 |
mobile | String | 手機號 |
faceImageUrl | String | 智能識別照片OSS KEY |
source | String | 來源:QRCODE, INPUT |
age | Integer | 年齡 |
degree | Integer | 學歷:0無; 1小學;2初中;3職高;4普高;5中專;6大專;7本科;8碩士;9博士 |
health | String | 健康狀態 |
marriage | Integer | 婚姻情況:0未婚; 1已婚; 2離異 |
politics | Integer | 政治面貌:0群眾;1黨員;2預備黨員;3積極分子;4入黨申請人;5 民主黨派 |
company | String | 工作單位 |
registry | String | 籍貫 |
residenceAddress | String | 戶籍所在地 |
registryCode | String | 籍貫編碼 |
residenceAddressCode | String | 戶籍所在地編碼 |
nationality | String | 國家/地區 |
approveComment | String | 審核拒絕原因 |
status | Integer | 住戶狀態 1已遷入、2待審核、3未通過、4已遷出 |
ext | String | 自定義擴展信息 |
1.5 查詢住戶列表
Path路徑 | /solution/community/paas/household/query |
請求方式 | post |
接口版本 | 1.0.5 |
請求參數
參數 | 類型 | 必填 | 描述 |
---|---|---|---|
communityId | Long | 否 | 小區Id |
houseSpaceId | String | 否 | 房屋空間ID |
mobile | String | 否 | 手機號 |
type | Integer | 否 | 關系: 1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
userName | String | 否 | 人名 |
modifiedStart | Long | 否 | 更新起始毫秒時間(含) |
modifiedEnd | Long | 否 | 更新結束毫秒時間(含) |
orderBy | JsonObject | 否 | 詳見OrderByDTO 排序規則:默認 gmt_create 降序排列。如果orderBy非空,則columnName和direction必填 |
pageNo | Integer | 否 | 頁碼 |
pageSize | Integer | 否 | 頁面大小 |
OrderByDTO
字段名 | 類型 | 必填 | 備注 |
---|---|---|---|
columnName | String | 是 | 排序列名,需要direction 配合使用,支持的輸入:gmt_create 創建時間gmt_modified 更新時間 |
direction | String | 是 | 排序方向:需要columnName配合使用支持的輸入desc 降序 |
返回參數
參數 | 類型 | 描述 |
total | Integer | |
pageNo | Integer | 頁碼 |
pageSize | Integer | 頁面大小 |
data | JSONArray | |
identityId | String | 用戶ID |
type | Integer | 關系: 1業主本人;2親屬;3租客;4朋友;5同事;6裝修人員;7保姆;8司機;9其它 |
alipayUid | String | 支付寶用戶(該字段不對外輸出) |
userName | String | 姓名 |
sex | Integer | 性別:1男 2女 |
idNo | String | 身份證號 |
mobile | String | 手機號 |
faceImageUrl | String | 智能識別照片OSS KEY |
source | String | 來源:QRCODE, INPUT |
age | Integer | 年齡 |
degree | Integer | 學歷:0無; 1小學;2初中;3職高;4普高;5中專;6大專;7本科;8碩士;9博士 |
health | String | 健康狀態 |
marriage | Integer | 婚姻情況:0未婚; 1已婚; 2離異 |
politics | Integer | 政治面貌:0群眾;1黨員;2預備黨員;3積極分子;4入黨申請人;5 民主黨派 |
company | String | 工作單位 |
registry | String | 籍貫 |
residenceAddress | String | 戶籍所在地 |
registryCode | String | 籍貫編碼 |
residenceAddressCode | String | 戶籍所在地編碼 |
gmtCreate | Long | 創建時間 |
gmtModified | Long | 更新時間 |
nationality | String | 國家/地區 |
ext | String | 自定義擴展信息 |
gmtCreate | Long | 創建時間 |
gmtModified | Long | 更新時間 |
1.6 查詢用戶的房屋列表
Path路徑 | /solution/community/paas/household/house/list |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數
參數 | 類型 | 必填 | 描述 |
identityId | String | 是 | 用戶ID |
返回參數
JSONArray
參數 | 類型 | 描述 |
communitySpaceId | String | 小區空間ID |
houseSpaceId | String | 房屋空間ID |
communityId | String | 小區ID |