Appearance
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 Name | Parameter Description | Request Type | Required | Data Type | Schema |
|---|---|---|---|---|---|
| fid | Family ID | query | true | string | |
| page | Current page, default is page 1 | query | false | integer(int32) | |
| pageSize | Page size, default is 10 items | query | false | integer(int32) |
Response Status:
| Status Code | Description | Schema |
|---|---|---|
| 200 | Successfully queried family room list | Registration code response data«PageInfo«List«RoomListVO»»» |
| 5041 | No permission | |
| 5618 | Please enter family ID |
Response Parameters:
| Parameter Name | Parameter Description | Type | Schema |
|---|---|---|---|
| code | Response status code | integer(int32) | integer(int32) |
| data | Response data | PageInfo«List«RoomListVO»» | PageInfo«List«RoomListVO»» |
| endRow | integer(int64) | ||
| hasNextPage | boolean | ||
| hasPreviousPage | boolean | ||
| isFirstPage | boolean | ||
| isLastPage | boolean | ||
| list | array | RoomListVO | |
| addTime | Add time | integer | |
| frid | Room ID | string | |
| roomName | Room name | string | |
| roomSort | Room order | 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:
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": ""
}