Skip to content

查询家庭中的家庭成员列表

接口地址:/v2/family/enduserapi/getFamilyMemberList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

查询家庭中的家庭成员列表

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
fid家庭idquerytruestring
page当前页,默认为第 1 页queryfalseinteger(int32)
pageSize页大小,默认为 10 条queryfalseinteger(int32)

响应状态:

状态码说明schema
200查询家庭中的家庭成员列表成功返回注册码响应数据«PageInfo«用户信息»»
5628未查询到用户信息
5635未开启家居模式
5636请输入家庭ID
5658成员权限不合法

响应参数:

参数名称参数说明类型schema
code响应状态码integer(int32)integer(int32)
data响应数据PageInfo«用户信息»PageInfo«用户信息»
  endRowinteger(int64)
  hasNextPageboolean
  hasPreviousPageboolean
  isFirstPageboolean
  isLastPageboolean
  listarray用户信息
    acceptTime接受邀请时间string
    address地址string
    alipayUserId支付宝用户IDstring
    appleUserId苹果用户IDstring
    city城市string
    emailemailstring
    facebookUserIdFacebook用户IDstring
    headimg头像string
    invalidTime邀请时间string
    lang语言string
    lastLoginTime最后登录时间string
    lastLoginTimeTsinteger
    memberName用户昵称string
    memberRole家庭成员角色:
1-家庭创建者,只有在自己创建的家庭中会拥有此角色
2-家庭管理员
3-家庭普通成员
integer
    nationality国家string
    nikeName昵称string
    phone手机号码string
    province省份string
    qqUserIdQQ用户IDstring
    registerTime注册时间string
    registerTimeTsinteger
    remark备注string
    sex性别string
    signature个性签名string
    status账号状态:0 禁用 1 正常integer
    timezone时区string
    twitterUserIdTwitter用户IDstring
    uid用户IDstring
    userDomain用户域string
    wechatMiniprogramUserId微信小程序用户IDstring
    wechatOffiaccountUserId微信公众号用户IDstring
    wechatUnionId微信通用用户IDstring
  navigateFirstPageinteger(int32)
  navigateLastPageinteger(int32)
  navigatePagesinteger(int32)
  navigatepageNumsarrayinteger
  nextPageinteger(int32)
  pageNuminteger(int32)
  pageSizeinteger(int32)
  pagesinteger(int32)
  prePageinteger(int32)
  sizeinteger(int32)
  startRowinteger(int64)
  totalinteger(int64)
extMsg扩展消息string
msg响应消息string

响应示例:

javascript
{
	"code": 0,
	"data": {
		"endRow": 0,
		"hasNextPage": true,
		"hasPreviousPage": true,
		"isFirstPage": true,
		"isLastPage": true,
		"list": [
			{
				"acceptTime": "",
				"address": "",
				"alipayUserId": "",
				"appleUserId": "",
				"city": "",
				"email": "",
				"facebookUserId": "",
				"headimg": "",
				"invalidTime": "",
				"lang": "",
				"lastLoginTime": "",
				"lastLoginTimeTs": 0,
				"memberName": "",
				"memberRole": 0,
				"nationality": "",
				"nikeName": "",
				"phone": "",
				"province": "",
				"qqUserId": "",
				"registerTime": "",
				"registerTimeTs": 0,
				"remark": "",
				"sex": "",
				"signature": "",
				"status": 0,
				"timezone": "",
				"twitterUserId": "",
				"uid": "",
				"userDomain": "",
				"wechatMiniprogramUserId": "",
				"wechatOffiaccountUserId": "",
				"wechatUnionId": ""
			}
		],
		"navigateFirstPage": 0,
		"navigateLastPage": 0,
		"navigatePages": 0,
		"navigatepageNums": [],
		"nextPage": 0,
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"prePage": 0,
		"size": 0,
		"startRow": 0,
		"total": 0
	},
	"extMsg": "",
	"msg": ""
}