全部产品
云市场

用户管理

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

用户管理

1用户组管理详情


1.1新建用户组

用户组是管理人员的基础单位,用户组中可以添加用户,也可以将用户组中的人脸下发到AIBOX或者门禁设备中。

**Path /solution/community/paas/user/group/add
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
communityId Long 小区Id
userGroupName String 用户组名称
userGroupType String 用户组类型
RESIDENT - 居民
VISITOR - 访客
PROPERTY - 物业
BLACKLIST - 黑名单

返回结果

字段名 类型 备注
data JSON 用户组id

用户组id

字段名 类型 备注
userGroupId String 用户组id

1.2更新用户组

更新设备组的名称。

**Path /solution/community/paas/user/group/update
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
userGroupName String 用户组名称
userGroupId String 用户组id

返回结果

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

1.3删除用户组

用户组布防,是将对应的用户组人脸同步至边缘AIBOX中,由AIBOX进行人员比对后形成人行数据,后续用户组的用户信息进行变更时,系统会自动进行用户照片的同步。

**Path /solution/community/paas/user/group/delete
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
userGroupId String 用户组id

返回结果

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

1.4查询用户组

根据用户组名称查询已有的用户组列表。

**Path /solution/community/paas/user/group/query
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
communityId Long 小区Id
userGroupName String 用户组名称
pageNo Integer 页码
pageSize Integer 页面数据条数

返回结果

字段名 类型 备注
data JSONArray 用户组结构

用户组结构

字段名 类型 备注
communityId Long 小区Id
userGroupId String 用户组ID
userGroupType String 用户组类型
userGroupName String 用户组名称

1.5结构化查询用户信息

根据用户组id查询组内的用户列表。

**Path /solution/community/paas/user/query
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
communityId Long 小区Id
userGroupId String 用户组id
userName String 用户名
mobile String 手机号
pageNo Integer 页码
pageSize Integer 页面数据条数

返回结果

字段名 类型 备注
data JSONArray 用户结构

人员结构

字段名 类型 备注
identityId String 用户ID
faceId String 人脸ID
userName String 用户名
faceImageUrl String 用户图片地址
idNo String 身份证号
userGroups JSONArray 用户组列表
age Integer 年龄
sex Integer 性别:1男,2女
mobile String 电话

userGroups详情:

字段名 类型 备注
userGroupId String 用户组ID
userGroupName String 用户组名称
userGroupType String 用户组类型


1.6查询用户信息

通过用户Id或人脸Id查询人员信息

**Path /solution/community/paas/user/get
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
communityId Long 小区Id
identityId String 用户Id
faceId String 人脸Id

返回结果

字段名 类型 备注
data JSONArray 人员结构

人员结构

字段名 类型 备注
identityId String 用户ID
faceId String 人脸ID
userName String 用户名
faceImageUrl String 用户图片地址
idNo String 身份证号
userGroups JSONArray 用户组列表
age Integer 年龄
sex Integer 性别:1男,2女
mobile String 电话

userGroups详情:

字段名 类型 备注
userGroupId String 用户组ID
userGroupName String 用户组名称
userGroupType String 用户组类型

1.7人脸图片查询用户信息

人脸检索用户,是通过一张用户的照片来检索用户组中的人员信息

**Path /solution/community/paas/user/getbyimage
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
communityId Long 小区Id
ossFileKey String 人脸图片地址, OSS文件的KEY

返回结果

字段名 类型 备注
data JSONArray 人员结构

人员结构

字段名 类型 备注
identityId String 用户ID
faceId String 人脸ID
userName String 用户名
faceImageUrl String 用户图片地址
idNo String 身份证号
userGroups JSONArray 用户组列表
age Integer 年龄
sex Integer 性别:1男,2女
mobile String 电话

userGroups详情:

字段名 类型 备注
userGroupId String 用户组ID
userGroupName String 用户组名称
userGroupType String 用户组类型


2用户管理详情

2.1添加用户

**Path /solution/community/paas/user/add
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
userGroupId String 用户组Id
userName String 用户名
mobile String 手机号
idNo String 证件号码
sex Integer 性别:1男,2女
age Integer 年龄
faceImageUrl String 人脸图片地址, OSS文件的KEY,参见1.8获取oss上传连接的说明

返回结果

字段名 类型 备注
data JSON 用户id

用户id

字段名 类型 备注
identityId String 用户Id
faceId String 用户id

2.2修改用户

**Path /solution/community/paas/user/update
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
identityId String 用户id
userName String 用户名
idNo String 证件号码
sex Integer 性别:1男,2女
age Integer 年龄
faceImageUrl String 人脸图片地址, OSS文件的KEY,参见1.6.7获取oss上传连接的说明

返回结果

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

2.3用户组添加用户

**Path /solution/community/paas/user/group/member/add
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
userGroupId String 用户组Id
identityId String 用户id

返回结果

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

2.4用户组删除用户

**Path /solution/community/paas/user/group/member/delete
** post
** 1.0.0

请求参数

字段名 类型 必填 备注
userGroupId String 用户组Id
identityId String 用户id

返回结果

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