Skip to content

Query Family Room List

API Address:/v2/family/enduserapi/getFamilyRoomList

Request Method:GET

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

Response Data Type:*/*

API Description:Query room list in family

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
fidFamily IDquerytruestring
pageCurrent page, default is page 1queryfalseinteger(int32)
pageSizePage size, default is 10 itemsqueryfalseinteger(int32)

Response Status:

Status CodeDescriptionSchema
200Successfully queried family room listRegistration code response data«PageInfo«List«RoomListVO»»»
5041No permission
5618Please enter family ID

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataPageInfo«List«RoomListVO»»PageInfo«List«RoomListVO»»
  endRowinteger(int64)
  hasNextPageboolean
  hasPreviousPageboolean
  isFirstPageboolean
  isLastPageboolean
  listarrayRoomListVO
    addTimeAdd timeinteger
    fridRoom IDstring
    roomNameRoom namestring
    roomSortRoom orderinteger
  navigateFirstPageinteger(int32)
  navigateLastPageinteger(int32)
  navigatePagesinteger(int32)
  navigatepageNumsarrayinteger
  nextPageinteger(int32)
  pageNuminteger(int32)
  pageSizeinteger(int32)
  pagesinteger(int32)
  prePageinteger(int32)
  sizeinteger(int32)
  startRowinteger(int64)
  totalinteger(int64)
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"endRow": 0,
		"hasNextPage": true,
		"hasPreviousPage": true,
		"isFirstPage": true,
		"isLastPage": true,
		"list": [
			{
				"addTime": 0,
				"frid": "",
				"roomName": "",
				"roomSort": 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": ""
}