Query Seat Information

Last Updated on : 2023-06-21 07:12:58download

This topic describes the APIs of Query Seat Information.

API description

Query the information about a specified seat.

API address

GET: /v1.0/iot-03/seats/{seat_id}

Request parameter

Parameter name	Type	IN	Required	Description
seat_id	String	uri	true	The seat ID.

Return parameter

Parameter name	Type	Description
result	SeatRes	The information about a specified seat.

Description of result

Parameter name	Type	Description
id	String	The seat ID.
seat_no	String	The seat number.
area_id	String	The ID of the area where the seat is located.
type	String	The seat type.
device_categories	List	The list of device types that are bound with the seat.
remark	String	Seat introduction.
image_url	String	The seat image.
status	String	Indicates the status of a seat. `disable`: The seat is disabled. Default value. `enable`: The seat is enabled. `repairing`: The seat is being repaired.
uid	String	The ID of a user who has registered for the seat.
user_name	String	The name of a user who has registered for the seat.

Request example

GET: /v1.0/iot-03/seats/1401807768616247xxx

Return example

{
    "result": {
        "image_url": "www.tuya.com",
        "user_name": "",
        "seat_no": "nice12444",
        "remark": "rest",
        "area_id": "1397463067465392xxx",
        "device_categories": [
            "cz"
        ],
        "type": "fixed",
        "uid": "",
        "id": "1401807768616247xxx",
        "status": "enable"
    },
    "t": 1623052073047,
    "success": true
}

Error code

See Error code.

Prev DocDelete Seat

Next DocQuery Seat List