AI 助理
备案控制台
文档
输入文档关键字查找
首页 数字社区平台 （文档停止维护） 智慧社区服务 接口开放 居民管理

居民管理

更新时间：
我的收藏

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

上一篇：用户管理下一篇：访客管理