2. 家庭API

API列表

编号 API名称
2.1 创建家庭
2.2 修改家庭名称
2.3 获取当前用户的家庭
2.4 获取家庭成员
2.5 邀请家庭成员
2.6 答复家庭邀请
2.7 加入家庭申请
2.8 答复加入家庭申请
2.9 成员退出
2.10 删除家庭成员
2.11 获取家庭信息
2.12 获取家庭申请
2.13 请求工程迁移家庭数据
2.14 请求获取用户e家家庭列表
2.15 提交工程迁移到云朵e家账号下
2.16 提交迁移

API调用

2.1 创建家庭

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/add

方法：POST

请求参数

名称 位置 类型 必填 描述
familyName BODY STRING 是 家庭名称

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

{
  "familyName": "家庭名称"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
familyId data LONG 否 家庭ID

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.2 修改家庭名称

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/modify

方法：POST

请求参数

名称 位置 类型 必填 描述
familyId BODY LONG 是 家庭ID
familyName BODY STRING 是 家庭名称

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

{
  "familyId": 1000,
  "familyName": "家庭名称"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.3 获取当前用户的家庭列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/list

方法：POST

请求参数

名称 位置 类型 必填 描述
includeMember BODY STRING 否 是否展示家庭成员(1=是，其他值则不展示)

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

{
    "includeMember":"1"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
familys data JSONArray 是 响应数据对象
familyId data.familys[] LONG 是 家庭Id
familyName data.familys[] STRING 是 家庭名称
property data.familys[] STRING 否 关联产权房屋
communityId data.familys[] STRING 否 社区Id
roleTag data.familys[] STRING 否 家庭角色
houseId data.familys[] STRING 否 房屋ID
communityId data.familys[] STRING 否 社区ID
communityName data.familys[] STRING 否 社区名称
status data.familys[] STRING 否 认证状态（1：已申请；2：已拒绝；3：迁出；4：认证成功）
members data.familys[] JSONArray 否 家庭成员
profilePhoto members[] STRING 否 头像
userId members[] LONG 否 用户ID
roleTag members[] STRING 否 家庭角色
nickName members[] STRING 否 用户昵称
mobile members[] STRING 否 用户手机号码
status members[] STRING 否 认证状态（1：已申请；2：已拒绝；3：迁出；4：认证成功）

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "familys": [{
        "familyId": 1000,
        "familyName": "xxxx",
        "communityId":"121212",
        "roleTag":"2",
        "property":"xxxxxx",
        "houseId": 0,
        "custId": 0,
        "communityName": "云朵默认社区",
        "communityId": 0,
        "status": "4",
        "members": [
            {
                "profilePhoto": "",
                "roleTag": 2,
                "nickName": "小美6195",
                "mobile": "13590620589",
                "userId": 129,
                "status": "4"
            }
        ],
      }]
     }
}

异常返回示例

{"code":"401","message":"error message"}

2.4 获取家庭成员

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/member/list

方法：POST

请求参数

名称 位置 类型 必填 描述
familyId BODY LONG 是 家庭ID

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

{
    "familyId":1000
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONArray 是 响应数据对象
members data JSONArray 是 家庭成员数组
userId data.members[] LONG 是 用户Id
userName data.members[] STRING 是 用户名称
mobile data.members[] STRING 是 手机号码
roleTag data.members[] STRING 是 家庭角色(2-业主 3-业主成员 14-租户 15-租户成员)

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "members":[{
        "userId": 1000,
        "userName": "xxxx",
        "mobile":"138xxxx",
        "roleTag":"2"
      }]
     }
}

异常返回示例

{"code":"401","message":"error message"}

2.5 邀请家庭成员

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/share/invite

方法：POST

请求参数

名称 位置 类型 必填 描述
invitee BODY LONG 是 被邀请用户ID
familyId BODY LONG 是 家庭ID
roleTag BODY STRING 是 家庭角色(2-业主 3-业主成员 14-租户 15-租户成员)

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

{
    "invitee": 10000,
    "familyId":1000,
    "roleTag": "2"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.6 答复家庭邀请

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/share/reply

方法：POST

请求参数

名称 位置 类型 必填 描述
inviteId BODY LONG 是 家庭邀请ID
reply BODY STRING 是 回复（0=拒绝 1=同意）a
applicantName BODY STRING 否 姓名
identity BODY STRING 否 身份证号码
moveOutOtherUser BODY BOOLEAN 否 是否迁出同一身份证其他用户的产权，默认时不迁出历史数据
houseLease body Json 否 租户信息

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

{
    "inviteId": 1000,
    "reply": "0"
    "houseLease": {
      {
     "start_time":"承租开始时间",
     "end_time":"承租结束时间",
     "lease_status":"承租状态 1承租",
     "remark":"备注",
     "attachment": "[{}]"
    }
   }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
"code":"200",
"message":"成功",
"result":{
"operateCode":"1999",
"operateMessage":"当前产权已被客户张**的188****1234认证，请确认是否继续，继续将迁出该手机号"
  }
}
这种返回需要前端弹出页面让用户二次确认，用户点击确认时，入参moveOutOtherUser传true

或

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

异常返回示例

{"code":"401","message":"error message"}

2.7 加入家庭申请

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/add/apply

方法：POST

请求参数

名称 位置 类型 必填 描述
familyId BODY LONG 是 申请加入的家庭ID
roleTag BODY STRING 是 家庭角色(2-业主 3-业主成员 14-租户 15-租户成员)
applicantName BODY STRING 是 姓名
identity BODY STRING 是 身份证号码

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

{
    "familyId":1000,
    "roleTag": "1",
    "applicantName":"张三",
    "identity":"xxxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.8 答复加入家庭申请

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/add/reply

方法：POST

请求参数

名称 位置 类型 必填 描述
applyId BODY LONG 是 家庭申请ID
reply BODY STRING 是 回复（0=拒绝 1=同意）
moveOutOtherUser BODY BOOLEAN 否 是否迁出同一身份证其他用户的产权，默认时不迁出历史数据

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

{
    "applyId": 1000,
    "reply": "0"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
"code":"200",
"message":"成功",
"result":{
"operateCode":"1999",
"operateMessage":"当前产权已被客户张**的188****1234认证，请确认是否继续，继续将迁出该手机号"
  }
}
这种返回需要前端弹出页面让用户二次确认，用户点击确认时，入参moveOutOtherUser传true

或


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

异常返回示例

{"code":"401","message":"error message"}

2.9 成员退出

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/share/quit

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY LONG 是 用户ID
familyId BODY LONG 是 家庭ID

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

{
    "userId": 10000,
    "familyId":1000
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.10 删除家庭成员

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/share/revoke

方法：POST

请求参数

名称 位置 类型 必填 描述
familyId BODY LONG 是 家庭ID
memberIds BODY JSONArray 是 家庭成员用户ID组

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

{
    "familyId":1000,
    "memberIds": [1000,1001]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

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

异常返回示例

{"code":"401","message":"error message"}

2.11 获取家庭信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/get

方法：POST

请求参数

名称 位置 类型 必填 描述
familyId BODY LONG 是 家庭ID

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

{
    "familyId":1000
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
name data STRING 否 家庭名称
property data STRING 否 关联产权
userId data LONG 否 业主ID
nickname data STRING 否 业主昵称
communityId data LONG 否 小区ID
status data STRING 否 状态

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
    "name": "云朵默认社区",
    "property": "佛山美的广场1栋",
    "nickname": "coderYK",
    "communityId": 21291194,
    "userId": 11,
    "status": "1"
  }
}

异常返回示例

{"code":"401","message":"error message"}

2.12 获取家庭申请/邀请信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/invitation/get

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 家庭申请Id/家庭邀请Id

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

{
    "id":1000
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
relationType data LONG 否 关系类型 0-业主邀请 1-用户申请
flag data LONG 否 标识，0是未处理 1是同意 2是拒绝
relationRole data LONG 否 角色
relationId data LONG 否 关联Id， 设备id或家庭id
userId data LONG 否 关联发起人
toUserId data LONG 否 关联接收人
extInfo data STRING 否 扩展信息

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
     "relationType": 1,
        "flag": 1,
        "relationRole": 3,
        "relationId": 537,
        "updateTime": 1570634903000,
        "toUserId": 354,
        "userId": 249,
        "extInfo": "{\"identity\":\"440811199605020027\",\"applicantName\":\"陈小\"}",
        "expireTime": 1570807683000,
        "createTime": 1570634883000,
        "updateBy": 354,
        "createUser": 249,
        "id": 450
  }
}

异常返回示例

{"code":"401","message":"error message"}

2.13 请求工程迁移家庭数据

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/smart-home/proxy header：namespace ： /sl/setup/migrate/req

方法：POST

请求参数

名称 位置 类型 必填 描述
userId header LONG 是 userId社区
namespace header string 是 /sl/setup/migrate/req

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

{
    "accessUID": "setup/uid:3257d329a68763af654802a03d5f2287af6451bd2785344201bfd82f29cb31e1bca92e3e55ccee88e97cd24e07b618b0"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

返回结果示例

{
"msgId": "70998391",
"errorCode": 0,
"msg": null,
"data": [{
"deviceNum": "2",
"houseName": "1栋101",
"houseId": "321594",
"gatewayName": "一代智能网关",
"house": {
"createTime": 1581561893000,
"roleTag": 0,
"name": "1栋101",
"updateTime": 1581561893000,
"id": 321594,
"userId": 24826
},
"gatewayId": "35622576193536"
}]
}

2.14 请求获取用户e家家庭列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/smart-home/proxy header：namespace ： /sl/home/house/list

方法：POST

请求参数

名称 位置 类型 必填 描述
userId header LONG 是 userId社区
namespace header string 是 /sl/home/house/list

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

{
    "msgId": "15410368092246875349549"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

返回结果示例

{
    "msgId": "15410368092246875349549",
    "errorCode": "0",
    "data": {
        "maxGatewayNum": "10",
        "houseinfos": [{
            "userPref": {},
            "houseId": "3329",
            "houseName": "我的家",
            "userId": 6875349549
        }, {
            "userPref": {},
            "houseId": "1715",
            "houseName": "心飞扬400",
            "userId": 142387
        }, {
            "userPref": {},
            "houseId": "3369",
            "houseName": "别人的家",
            "userId": 6875349549
        }, {
            "userPref": {},
            "houseId": "3261",
            "houseName": "心飞扬500",
            "userId": 142387
        }]
    }
}

2.15 提交工程迁移到云朵e家账号下

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： uri：/spaceservice/family/setup/migrate/submit

方法：POST

请求参数

名称 位置 类型 必填 描述
userId body LONG 是 userId社区
familyId body string 是 familyId

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

{
    "msgId": "15410368092246875349549",
    "accessUID": "setup/uid:3257d329a68763af654802a03d5f2287af6451bd275344201bfd82f29cb31e1bca92e3e55ccee88e97cd24e07b618b0",
    "familyId": 111,
    "userId": 123
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

返回结果示例

{
"msgId": "75910090",
"code": 0,
"msg": null,
"data":{"houseId":"123456"}
}

2.16 提交迁移

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/spaceservice/family/home/house/migrate

方法：POST

请求参数

名称 位置 类型 必填 描述
userId body LONG 是 userId社区
familyId body string 是 familyId

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

{
    "msgId": "123123",
    "familyId": 111,
    "userId": 123,
    "communityInfo": {
        "communityId": 111,
        "communityHouseId": 111,
        "houseId": 222,
        "houseName": "xxx"
    },
    "smartLifeInfo": {
        "houseId": 123,
        "houseName": "xxx"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

返回结果示例

{
"msgId": "75910090",
"code": 0,
"msg": null,
"data":{"houseId":"123456"}
}

成员权限设置（暂不做）

错误码列表(12001-12999)

错误码 错误信息 描述
12001
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""