Navigation :

家庭管理

家庭管理接口格式

String familyManagement(String action, String params, BLLetAsyncRequestCallbacker callbacker)

创建家庭

    action:CreateFamily
    params:
	{
		"name": "xxx", // 家庭名称，可以为空
        "country": "xxxx"  // 家庭所在国家，可以为空
        "province": "xxxx"  // 家庭所在省份，可以为空
        "city": "xxxx"     // 家庭所在城市，可以为空
	}	
    返回:
		{
			"status":0,
			"msg" :"success",
			"familyInfo": familyInfo,// 家庭基本信息，详情见附录表格
			"roomList" : [		// 自动创建的房间列表
					roomInfo,	// 房间信息
					roomInfo
				]
		}

查询家庭基本信息

注意：如果有多个家庭，返回的可能是一个家庭列表

    action:GetFamilyList
    params:
	{
		"userid": "xxx" // 用户登录成功返回的userid
	}
    返回:
    {
        "status":0,
        "msg":"success",
        "familyList":[ 		// 用户下所有家庭的基本信息列表
                        familyInfo,
                        familyInfo
                    ]
    }

查询家庭全部信息

    action:GetFamilyDetailInfo
    params:
		familyInfo
    返回:
		{
			"status":0,
			"msg":"success",
			"familyInfo": familyInfo,
			"endPointList": [		// 家庭内终端信息列表
                			endPointInfo,
                			endPointInfo
               			],
			"roomList":[			// 家庭内房间信息列表
                        	roomInfo,
                       		roomInfo
				]
		}

修改家庭信息

    action:ModifyFamilyInfo
    params:
        familyInfo
    返回:
        {
            "status":0,
            "msg":"success",
            "familyInfo": familyInfo,
        }

删除家庭

    action:DelFamily
    params:
        familyInfo
    返回:
        {
            "status":0,
            "msg":"success"
        }

向家庭中添加终端

    action:AddEndpoint
    params: 
		{
		 	"familyInfo":familyInfo,		// 需要添加到的家庭信息
		 	"roomInfo":roomInfo,			// 需要添加到的房间信息
		 	"endPointInfo":endPointInfo		// 需要添加的终端信息
		}
    返回:
		{
			"status":0,
			"msg":"success",
			"familyInfo": familyInfo,		// 添加完成之后的家庭信息
			"endPointInfo": endPointInfo	// 添加完成之后的终端信息
		}

从家庭中删除终端

    action:DeleteEndpoint
    params: 
		{
		 	"familyInfo":familyInfo,
		 	"endPointInfo":endPointInfo
		}	
    返回:
		{
			"status":0,
			"msg":"success",
			"familyInfo": familyInfo
		}

更新终端描述信息

    action:UpdateEndpoint
    params:
		{
		 	"familyInfo":familyInfo,
		 	"endPointInfo":endPointInfo
		}	
    返回:
		{
			"status":0,
			"msg":"success",
			"familyInfo": familyInfo
		}

更新终端位置信息

    action:UpdateEndpointLocation
    params:
		{
		 	"familyInfo":familyInfo,
		 	"endPointInfo":endPointInfo,
		  	"roomInfo" : roomInfo
		}
    返回:
    {
        "status":0,
        "msg":"success",
        "familyInfo": familyInfo
    }

房间管理

   action:ManageRoom
    params:
		{
		 	"familyInfo":familyInfo,
		  	"roomInfo" : roomInfo,
		  	"action" : "xxxxx"			// 对房间的操作 "add" "modify" "del"
		}
    返回:
    {
        "status":0,
        "msg":"success",
        "familyInfo": familyInfo
    }

参数说明

action 可输入参数值如下表：

参数值	参数说明
add	添加房间，添加房间对应的roomInfo 无须 roomId
modify	房间修改, 必须传入对应的 roomId
del	删除房间, 必须传入对应的 roomId

家庭通用HTTP接口

该接口封装家庭相关HTTP请求，使用前需了解相关云端API参数

    action:FamilyCommonHttpRequest
    params:
		{
		 	"urlPath" : "xxxxx",			// URL路径 不包含 domain
		 	"head" : {},					// HTTP请求头 不包含 "userid" "loginsession" "timestamp" "token" "lid"
		 	"body" : {}						// HTTP请求内容
		}
    返回:
    	{}		// 云端返回数据