查询家庭列表
接口地址:/v2/family/enduserapi/getFamilyList
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
查询家庭列表
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| page | 当前页，默认为第 1 页 | query | false | integer(int32) | |
| pageSize | 页大小，默认为 10 条 | query | false | integer(int32) | |
| role | 成员角色：1-创建者 2-管理员 3-普通成员，多个使用英文逗号分隔 | query | false | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | 查询家庭列表成功 | 返回注册码响应数据«PageInfo«List«创建家庭返回信息»»» |
| 5041 | 没有权限 | |
| 5635 | 未开启家居模式 |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | 响应状态码 | integer(int32) | integer(int32) |
| data | 响应数据 | PageInfo«List«创建家庭返回信息»» | PageInfo«List«创建家庭返回信息»» |
| endRow | integer(int64) | ||
| hasNextPage | boolean | ||
| hasPreviousPage | boolean | ||
| isFirstPage | boolean | ||
| isLastPage | boolean | ||
| list | array | 创建家庭返回信息 | |
| addTime | 添加时间 | integer | |
| addTimeTs | 添加时间时间戳 | integer | |
| familyCoordinates | 家庭经纬度 | string | |
| familyLocation | 家庭位置 | string | |
| familyName | 家庭名称 | string | |
| fid | 家庭ID | string | |
| memberRole | 用户角色 1：创建者 2：管理员 3：普通用户 | integer | |
| 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": [
{
"addTime": 0,
"addTimeTs": 0,
"familyCoordinates": "",
"familyLocation": "",
"familyName": "",
"fid": "",
"memberRole": 0
}
],
"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": ""
}