Query Meeting Rooms on Pages

Last Updated on : 2023-06-15 05:44:02

Query the list of meeting rooms that meet the specified criteria. If multiple labels are passed in, the returned result shows the meeting rooms that meet all these labels.

API address

GET: /v2.0/iot-03/meeting-rooms

Request parameter

Parameter name	Type	IN	Required	Description
parent_asset_id	String	query	false	The group ID of specified meeting rooms.
name	String	query	false	The name of a specified meeting room.
type	String	query	false	The type of a specified meeting room.
room_status	String	query	false	The status of a specified meeting room.
range_type	String	query	false	The opening range of a specified meeting room.
reservation_approved	String	query	false	Specifies whether to enable approval of the reservation.
space	Integer	query	false	The number of people that can be accommodated in a specified meeting room.
tag_codes	String	query	false	The code of a meeting room label, separated with commas (,).
page_size	Integer	query	false	The number of items returned on each page.
page_no	Integer	query	false	The page number.

Return parameter

Parameter name	Type	Description
result	Page	The list of meeting rooms on pages.

Description of result

Parameter name	Type	Description
total	Long	The total entries of meeting rooms that meets the criteria.
list	List	The list of meeting rooms.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
id	String	The ID of a specified meeting room.
name	String	The name of a specified meeting room.
image_url	String	The URL of the first image for a specified meeting room.
type	String	The type of a specified meeting room. Valid values: `normal`: general meeting room. `vip`: VIP meeting room.
address	String	The location of a specified meeting room.
longitude	String	The longitude of a specified meeting room.
latitude	String	The latitude of a specified meeting room.
parent_asset_id	String	The group ID of specified meeting rooms.
range_type	String	The opening range of a specified meeting room. Valid values: `all`: The meeting room is open to all persons. `personnel`: The meeting room is open to specified persons.
room_status	String	The status of a specified meeting room. Valid values: `open`: The meeting room is open for reservation. `stop`: The meeting room is suspended.
suspension_remark	String	The remarks on suspension.
reservation_approved	String	Specifies whether to enable approval of the reservation. Valid values: `Y`: enable. `N`: disable.
approval_process_id	String	The ID of the approval process for a specified meeting room.
preemptible	String	Indicates whether a meeting room can be occupied by another person if the person who makes the reservation does not appear within the specified time. Valid values: `Y`: yes. `N`: no.
system_release	String	Indicates whether the reservation of a meeting room can be released by the system. Valid values: `Y`: enabled. `N`: disabled.
space	Integer	The number of people that can be accommodated in a specified meeting room.

Request example

GET: /v2.0/iot-03/meeting-rooms?parent_asset_id=1410069474429693***&reservation_approved=Y

Return example

{
    "result": {
        "list": [
            {
                "approval_process_id": "1409770198688333907",
                "address": "F12, Building A, Grand Center",
                "image_url": "www.tuya.com",
                "latitude": "111.4",
                "range_type": "personnel",
                "type": "vip",
                "space": 12,
                "room_status": "open",
                "preemptible": "Y",
                "parent_asset_id": "1410069474429693952",
                "name": "VIP Meeting Room No. 44",
                "id": "1410148741926678528",
                "reservation_approved": "Y",
                "system_release": "Y",
                "suspension_remark": "",
                "longitude": "108.3"
            },
            {
                "approval_process_id": "1409770198688333907",
                "address": "F12, Building A, Grand Center",
                "image_url": "",
                "latitude": "111.4",
                "range_type": "personnel",
                "type": "vip",
                "space": 12,
                "room_status": "open",
                "preemptible": "N",
                "parent_asset_id": "1410069474429693952",
                "name": "VIP Meeting Room No. 3",
                "id": "1410146314074779648",
                "reservation_approved": "Y",
                "system_release": "N",
                "suspension_remark": "",
                "longitude": "108.3"
            }
        ],
        "total": 2,
        "has_more": false
    },
    "t": 1625053155389,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Meeting Room

Next DocQuery Meeting Room