Query Family List

API Address:/v2/family/enduserapi/getFamilyList

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Query family list

Request Parameters:

Parameter Name	Parameter Description	Request Type	Required	Data Type	Schema
page	Current page, default is page 1	query	false	integer(int32)
pageSize	Page size, default is 10 items	query	false	integer(int32)
role	Member role: 1-Creator 2-Administrator 3-Regular member, multiple roles separated by commas	query	false	string

Response Status:

Status Code	Description	Schema
200	Successfully queried family list	Registration code response data«PageInfo«List«Create Family Return Info»»»
5041	No permission
5635	Home mode not enabled

Response Parameters:

Parameter Name	Parameter Description	Type	Schema
code	Response status code	integer(int32)	integer(int32)
data	Response data	PageInfo«List«Create Family Return Info»»	PageInfo«List«Create Family Return Info»»
endRow		integer(int64)
hasNextPage		boolean
hasPreviousPage		boolean
isFirstPage		boolean
isLastPage		boolean
list		array	Create Family Return Info
addTime	Add time	integer
addTimeTs	Add time timestamp	integer
familyCoordinates	Family coordinates	string
familyLocation	Family location	string
familyName	Family name	string
fid	Family ID	string
memberRole	User role 1: Creator 2: Administrator 3: Regular user	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	Extended message	string
msg	Response message	string

Response Example:

{
	"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": ""
}