2. 用户中台API

API列表

编号 API名称 路径 版本
2.1 获取用户列表 /mid/user/query/list 3.0
2.2 获取用户信息 /mid/user/query/info 1.0
2.3 注册用户 /mid/user/create 1.0
2.4 更新用户信息 /mid/user/update/info 1.0
2.5 更新用户数据状态 /mid/user/update/state 1.0
2.6 更新用户账号 /mid/user/credentials/acct 1.0
2.7 验证用户账号 /mid/user/credentials/auth 1.0
2.8 查询用户认证客户列表 /mid/user/cust/query/list 1.0
2.9 重置用户密码 /mid/user/password/reset 1.0
2.10 校验用户密码 /mid/user/password/validate 1.0
2.11 小区产权选择列表 /mid/user/propertyauth/house/selectlist 3.0
2.12 楼栋楼层列表选择 /mid/user/propertyauth/house/selectbuid 3.0
2.13 修改启用状态码接口 /mid/user/propertyauth/myhouse/alterOnStatus 3.0
2.14 查看房屋家庭成员信息 /mid/user/house/memberslist 3.0
2.15 模糊搜索用户名称 /mid/user/house/userlist 3.0

API调用

2.1: 获取用户列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
search BODY String 否 模糊查询内容:昵称/姓名/手机号
communityId BODY Long 否 社区号
userSrc BODY String 否 用户来源:C4A：云朵2.0；smartCommunity：云朵3.0；4A：云管家
houseId BODY Integer 否 房屋Id
roleTag BODY String 否 用户角色: 2：业主，3业主成员，14租户，15租户成员
relStatus BODY Integer 否 房产认证状态:0:未申请；1：已申请；2：已拒绝；3：迁出；4：认证成功
onStatus BODY Integer 否 启用状态:0:禁用；1：启用
pageNo BODY Integer 否 当前页
pageSize BODY Integer 否 每页条数

请求Body描述(非Form表单数据)

        {
        "search":"",
        "userSrc":"",
        "communityId":"21441118",
        "houseId":"",
        "roleTag":"",
        "relStatus":"",
        "onStatus":"1",
        "pageNo": 1,
        "pageSize": 10
        }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
appCode BODY STRING 否 应用分类。具体参考
typeCode BODY String 否 用户类型
userName BODY String 否 用户名称
realName BODY String 否 用户真名
userPhone BODY String 否 用户手机
certiType BODY String 否 证件类型
certiNbr BODY String 否 证件号码
status BODY String 否 状态：1.启用；0.停用
roleTag BODY String 否 用户角色: 2：业主，3业主成员，14租户，15租户成员
relStatus BODY Integer 否 房产认证状态:0:未申请；1：已申请；2：已拒绝；3：迁出；4：认证成功
onStatus BODY Integer 否 启用状态:0:禁用；1：启用
propertyType BODY Integer 否 启用状态:1:房屋；2：车位
userSrc BODY String 否 用户来源:C4A：云朵2.0；smartCommunity：云朵3.0；4A：云管家
houseId BODY Integer 否 房屋Id
house BODY String 否 房屋地址
createTime BODY String 否 注册时间
certificationTime BODY String 否 认证时间
approvedTime BODY String 否 审核时间
pageNo BODY Integer 否 当前页
pageSize BODY Integer 否 每页条数
返回结果示例
{
    "code": 200,
    "data": {
        "total": 116,
        "pages": 12,
        "pageNo": 1,
        "pageSize": 10,
        "users": [
            {
                "appCode": "1000",
                "typeCode": "A01",
                "userId": "13416",
                "nickname": "小美78589",
                "userName": "2218测试004",
                "realName": "2218测试004",
                "userPhone": "13430220004",
                "certiType": "",
                "certiNbr": "",
                "gender": "",
                "status": "1",
                "userPhoto": "",
                "roleTags": "2",
                "relStatus": 4,
                "userSrc": "C4A",
                "communityId": 21441118,
                "communityName": "领贤体验馆02",
                "propertyType": 1,
                "houseId": 35692438,
                "house": "10栋204",
                "onStatus": 1,
                "createTime": "2020-03-09T01:36:33.000+0000",
                "certificationTime": "2020-01-14T06:31:14.000+0000",
                "approvedTime": "2020-01-14T06:31:14.000+0000"
            }
        ]
    },
    "message": "success"
    }
异常返回示例
{"code":"1201","message":""}

2.2: 获取用户信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 用户ID

请求Body描述(非Form表单数据)

{
  "userId": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
userInfo data JSONObject 是 用户信息
userId userInfo STRING 是 用户ID
userName userInfo STRING 是 用户名称
userPhone userInfo STRING 是 用户手机号
certiType userInfo STRING 是 证件类型
certiNbr userInfo STRING 是 证件号码
gender userInfo STRING 是 用户性别
status userInfo STRING 是 状态：1.启用；0.停用
userPhoto userInfo STRING 是 用户头像
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "userInfo":{
        "userId": "",
        "userName": "",
        "userPhone": "",
        "certiType": "",
        "certiNbr": "",
        "gender": "",
        "status": "",
        "userPhoto": ""
     }
  }
}
异常返回示例
{"code":"1201","message":""}

2.3: 注册用户

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/create

方法：POST

请求参数

名称 位置 类型 必填 描述
appCode BODY STRING 否 应用分类
typeCode BODY STRING 否 用户类型
userName userInfo STRING 是 用户名称
userPhone userInfo STRING 是 用户手机
certiType userInfo STRING 是 证件类型
certiNbr userInfo STRING 是 证件号码
gender userInfo STRING 是 用户性别

请求Body描述(非Form表单数据)

{
  "appCode": "1000",
  "typeCode": "A01",
  "userName": "",
  "userPhone": "",
  "certiType": "",
  "certiNbr": "",
  "gender": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
userId data STRING 是 用户ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "userId":""
  }
}

2.4: 更新用户信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
appCode BODY STRING 否 应用分类
typeCode BODY STRING 否 用户类型
userId BODY STRING 是 用户ID
userName userInfo STRING 是 用户名称
userPhone userInfo STRING 是 用户手机
certiType userInfo STRING 是 证件类型
certiNbr userInfo STRING 是 证件号码
gender userInfo STRING 是 用户性别
请求Body描述(非Form表单数据)
{
    "userId":"",
    "userName": "",
  "userPhone": "",
  "certiType": "",
  "certiNbr": "",
  "gender": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

2.5: 更新用户数据状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/update/state

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 用户ID
status BODY STRING 是 用户状态

请求Body描述(非Form表单数据)

{
  "userId": "",
  "status": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

2.6: 更新用户账号

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/credentials/acct

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 用户ID
account BODY STRING 是 账号
password BODY STRING 是 密码

请求Body描述(非Form表单数据)

{
  "userId": "01",
  "account": "01",
  "password": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

2.7: 验证用户账号

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/credentials/auth

方法：POST

请求参数

名称 位置 类型 必填 描述
appCode BODY STRING 否 应用分类
userName BODY STRING 是 用户账号
password BODY STRING 是 用户密码

请求Body描述(非Form表单数据)

{
  "appCode": "01",
  "userName": "",
  "password": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.8: 查询用户认证客户列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/cust/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 用户ID
projectId BODY STRING 否 项目ID

请求Body描述(非Form表单数据)

{
  "userId": "123456",
  "projectId": "12345678"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customers data JSONArray 是 客户列表集
userId customers STRING 是 用户ID
projectId customers STRING 是 项目ID
custId customers STRING 是 客户ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    "customers":[{
      "userId": "123456",
        "projectId": "12345678",
        "custId": "456789"}]
  }
}

2.9: 重置用户密码

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/password/reset

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 用户ID

请求Body描述(非Form表单数据)

{
  "userId": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     }
  }

2.10: 检验用户密码

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/password/validate

方法：POST

请求参数

名称 位置 类型 必填 描述
userName BODY STRING 是 用户账号
password BODY STRING 是 用户密码

请求Body描述(非Form表单数据)

{
      "userName": "135xxxxx",
    "password":"xxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     }
  }

2.11: 小区产权选择列表

描述：

请求信息

HTTP协议：HTTP,HTTPS

uri:/mid/user/propertyauth/house/selectlist

方法：POST

请求参数(BODY)

名称 位置 类型 必填 描述
communityId BODY Integer 是 社区ID

请求Body描述(非Form表单数据)

{
  "communityId":21291194
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
houses data ARRAY 是 房屋列表
houseId data.houses[] STRING 是 家庭ID
roomNo data.houses[] STRING 是 房间号
buildName data.houses[] STRING 是 楼栋名
unit data.houses[] STRING 是 单元号
floor data.houses[] STRING 是 楼层

返回结果示例 

{
"code": 200,
"data": {
    "houses": [
        {
            "buildNum": 8,
            "buildName": "8栋",
            "unit": "1单元",
            "houseId": 35000454,
            "roomNo": "201",
            "floor": "2层",
            "roomNoLong": 201
        },
        ....
       "message": "success"
 }

2.12: 楼栋楼层列表选择

描述：

请求信息

HTTP协议：HTTP,HTTPS

uri:/mid/user/propertyauth/house/selectbuid

方法：POST

请求参数(BODY)

名称 位置 类型 必填 描述
communityId BODY Integer 是 社区ID
buildName BODY String 是 楼栋号
floor BODY String 否 楼层号

请求Body描述(非Form表单数据)

{
  "communityId":21291194,
  "buildName":"8栋",
  "floor":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
houses data ARRAY 是 房屋列表
houseId data.houses[] STRING 是 家庭ID
roomNo data.houses[] STRING 是 房间号
buildName data.houses[] STRING 是 楼栋名
unit data.houses[] STRING 是 单元号
floor data.houses[] STRING 是 楼层

返回结果示例 

{
"code": 200,
"data": {
    "houses": [
        {
            "buildNum": 8,
            "buildName": "8栋",
            "unit": "1单元",
            "houseId": 35000454,
            "roomNo": "201",
            "floor": "2层",
            "roomNoLong": 201
        },
        ....
       "message": "success"
 }

2.13:修改启用状态码接口</pan>

描述：

请求信息

HTTP协议：HTTP,HTTPS

uri:/mid/user/propertyauth/myhouse/alterOnStatus

方法：POST

请求参数(BODY)

名称 位置 类型 必填 描述
communityId BODY Integer 是 社区ID
houseId BODY Integer 是 房屋ID
phoneNum BODY String 是 用户电话
onStatus BODY Integer 是 启用状态标识：0：禁用；1：启用

请求Body描述(非Form表单数据)

{
"communityId":1003837,
"houseId":736579,
"phoneNum":"18665866975",
"onStatus":0
}

返回信息

返回参数类型

JSON

返回结果示例 

 {
"code": 200,
"data": {},
"message": "success"
}

2.14:查看房屋家庭成员信息

描述：

请求信息

HTTP协议：HTTP,HTTPS

uri:/mid/user/house/memberslist

方法：POST

请求参数(BODY)

名称 位置 类型 必填 描述
communityId BODY Long 是 社区ID
houseId BODY Long 是 房屋号
pageNo BODY Integer 否 页码
pageSize BODY Integer 否 页数

请求Body描述(非Form表单数据)

 {
"communityId":"21441118",
"houseId":35650825
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
users data JSONArray 是 用户列表
appCode BODY STRING 否 应用分类。具体参考
typeCode BODY STRING 否 用户类型
userName BODY STRING 否 客户名称
userPhone BODY STRING 否 用户手机
realName BODY String 否 用户真名
certiType BODY STRING 否 证件类型
certiNbr BODY STRING 否 证件号码
gender BODY STRING 否 性别(F/M)
status BODY STRING 否 状态：1.启用；0.停用
userPhoto BODY STRING 否 用户头像
roleTag BODY String 否 用户角色: 2：业主，3业主成员，14租户，15租户成员
relStatus BODY Integer 否 房产认证状态:0:未申请；1：已申请；2：已拒绝；3：迁出；4：认证成功
onStatus BODY Integer 否 启用状态:0:禁用；1：启用
propertyType BODY Integer 否 启用状态:1:房屋；2：车位
userSrc BODY String 否 用户来源:C4A：云朵2.0；smartCommunity：云朵3.0；4A：云管家
houseId BODY Integer 否 房屋Id
house BODY String 否 房屋地址
communityId BODY Integer 否 社区ID
communityName BODY String 否 社区名

返回结果示例 

  {
"code": 200,
"data": {
    "total": 9,
    "pages": 1,
    "pageNo": 1,
    "pageSize": 100,
    "users": [
        {
            "appCode": "1000",
            "typeCode": "A01",
            "userId": "9",
            "userName": "来来1",
            "realName": "杨观超",
            "userPhone": "13005428825",
            "certiType": "",
            "certiNbr": "",
            "gender": "",
            "status": "1",
            "userPhoto": "",
            "roleTags": "2",
            "relStatus": null,
            "userSrc": "",
            "communityId": 21441118,
            "communityName": "领贤体验馆02",
            "propertyType": null,
            "houseId": 35650825,
            "house": "",
            "onStatus": null
        },
       ....
"message": "成功"
 }

2.15:模糊搜索用户名称

描述：

请求信息

HTTP协议：HTTP,HTTPS

uri:/mid/user/house/userlist

方法：POST

请求参数(BODY)

名称 位置 类型 必填 描述
communityId BODY Long 是 社区ID
search BODY String 是 搜索
houseIds BODY Array 是 房产ids
unitIds BODY Array 是 单元ids
roleTags BODY Array 是 身份标识
pageNo BODY Integer 否 页码
pageSize BODY Integer 否 页数

请求Body描述(非Form表单数据)

{
    "search":"李",
    "communityId":610,
    "houseIds":[],
    "unitIds":[],
    "roleTags":[],
    "pageNo":1,
    "pageSize":10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 Object 是 响应数据对象
userList data Array 是 用户信息列表
buildId BODY LONG 是 楼栋ID
buildName BODY STRING 是 楼栋名
unitId BODY LONG 是 单元ID
unitName BODY STRING 是 单元名
floorId BODY LONG 是 楼层ID
floorName BODY STRING 是 楼层名
houseId BODY LONG 是 房屋ID
houseName BODY STRING 是 房屋名
custName BODY STRING 是 客户名称
userId BODY LONG 是 用户id
roleTag BODY INTEGER 是 身份

返回结果示例 

{
    "code": 200,
    "data": {
        "total": 4,
        "current": 1,
        "userList": [
            {
                "floorId": 50093126,
                "houseName": "2501",
                "buildName": "20栋",
                "houseId": 278221,
                "unitName": "1单元",
                "roleTag": 2,
                "unitId": 8289,
                "buildId": 5209,
                "floorName": "25",
                "custName": "李沛林",
                "userId": 359
            }
        ],
        "pages": 1,
        "size": 10
    },
    "message": "success"
}

错误码列表(1201-1299)

错误码 错误信息 描述
1201 the user not exists 用户不存在
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""