Query Room List

Last Updated on : 2023-06-21 07:13:04

Based on the unique identifier (ID) of a project, query the list of rooms under the project.

API address

GET: /v2.0/osaas/projects/{project_id}/rooms

Request parameter

Parameter name	Type	IN	Required	Description
project_id	String	uri	true	The unique ID of a specified project.
request	RoomAbilityPageRequest		false	The request of querying the rooms on pages.

Description of request

Parameter name	Type	IN	Required	Description
page_no	Integer		false	The page number. The page number must be greater than `0`. Default value: `1`.
page_size	Integer		false	The number of items returned on each page. `0` < `page_size` < `1000`. Default value: `20`.

Return parameter

Parameter name	Type	Description
result	RoomAbilityPageResponse	The returned result of querying the rooms on pages.

Description of result

Parameter name	Type	Description
rooms	List	A list of rooms.
total	Integer	The total number of returned items.
page_no	Integer	The page number.
page_size	Integer	The number of items returned on each page.

Description of rooms

Parameter name	Type	Description
room_id	String	The unique ID of a specified room.
room_name	String	The name of a specified room.
room_no	String	The number of a specified room.
gmt_create	Long	The 13-digit timestamp of the creation time.
gmt_modified	Long	The 13-digit timestamp of the modification time.

Request example

GET: /v2.0/osaas/projects/150188910571223***/rooms

Return example

{
    "tid": "0f6740840e4311edae057e1****",
    "result": {
        "rooms": [
            {
                "gmt_create": 1650272458625,
                "room_id": "15159786846****",
                "gmt_modified": 1650272458625,
                "room_name": "2001",
                "room_no": "2001"
            }
        ],
        "page_no": 1,
        "total": 1,
        "page_size": 10
    },
    "t": 1658991671051,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Room Information

Next DocHotel Project Management