查询家庭中的家庭成员列表
接口地址:/v2/family/enduserapi/getFamilyMemberList
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
查询家庭中的家庭成员列表
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
fid | 家庭id | query | true | string | |
page | 当前页,默认为第 1 页 | query | false | integer(int32) | |
pageSize | 页大小,默认为 10 条 | query | false | integer(int32) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | 查询家庭中的家庭成员列表成功 | 返回注册码响应数据«PageInfo«用户信息»» |
5628 | 未查询到用户信息 | |
5635 | 未开启家居模式 | |
5636 | 请输入家庭ID | |
5658 | 成员权限不合法 |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 响应数据 | PageInfo«用户信息» | PageInfo«用户信息» |
endRow | integer(int64) | ||
hasNextPage | boolean | ||
hasPreviousPage | boolean | ||
isFirstPage | boolean | ||
isLastPage | boolean | ||
list | array | 用户信息 | |
acceptTime | 接受邀请时间 | string | |
address | 地址 | string | |
alipayUserId | 支付宝用户ID | string | |
appleUserId | 苹果用户ID | string | |
city | 城市 | string | |
string | |||
facebookUserId | Facebook用户ID | string | |
headimg | 头像 | string | |
invalidTime | 邀请时间 | string | |
lang | 语言 | string | |
lastLoginTime | 最后登录时间 | string | |
lastLoginTimeTs | integer | ||
memberName | 用户昵称 | string | |
memberRole | 家庭成员角色: 1-家庭创建者,只有在自己创建的家庭中会拥有此角色 2-家庭管理员 3-家庭普通成员 | integer | |
nationality | 国家 | string | |
nikeName | 昵称 | string | |
phone | 手机号码 | string | |
province | 省份 | string | |
qqUserId | QQ用户ID | string | |
registerTime | 注册时间 | string | |
registerTimeTs | integer | ||
remark | 备注 | string | |
sex | 性别 | string | |
signature | 个性签名 | string | |
status | 账号状态:0 禁用 1 正常 | integer | |
timezone | 时区 | string | |
twitterUserId | Twitter用户ID | string | |
uid | 用户ID | string | |
userDomain | 用户域 | string | |
wechatMiniprogramUserId | 微信小程序用户ID | string | |
wechatOffiaccountUserId | 微信公众号用户ID | string | |
wechatUnionId | 微信通用用户ID | string | |
navigateFirstPage | integer(int32) | ||
navigateLastPage | integer(int32) | ||
navigatePages | integer(int32) | ||
navigatepageNums | array | integer | |
nextPage | integer(int32) | ||
pageNum | integer(int32) | ||
pageSize | integer(int32) | ||
pages | integer(int32) | ||
prePage | integer(int32) | ||
size | integer(int32) | ||
startRow | integer(int64) | ||
total | integer(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": ""
}