Query Seat List

Last Updated on : 2023-06-21 07:13:00download

This topic describes the APIs of Query Seat List.

API description

Query the list of seats.

API address

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

Request parameter

Parameter name Type IN Required Description
req SeatQueryListReq query true The request of querying the list of seats.

Description of req

Parameter name Type IN Required Description
area_id String false The ID of the area where the seat is located.
seat_no String false The seat number.
type String false The seat type.
device_category String false The device type.
status String false The status of a specified seat.
org_id String false The ID of a specified organization.
user_name String false The username.
page_size Integer false The number of pages.
page_no Integer false The page number.

Return parameter

Parameter name Type Description
result Page The returned result of seats on pages.

Description of result

Parameter name Type Description
has_more Boolean Indicates whether additional data is available.
list List The list of seats.
total Long The total entries of data that meets the criteria.

Description of total

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.
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 user ID.
user_name String The username.

Request example

GET: /v1.0/iot-03/seats?area_id=1394999880337850xxx&seat_no=seat7-1&type=fixed&device_category=cz&user_name=useraccount&page_size=10&page_no=2

Return example

{ "result": { "list": [ { "image_url": "www.tuya.com", "user_name": "useraccount", "seat_no": "seat7-1", "remark": "1", "area_id": "1394999880337850xxx", "device_categories": [ "cz", "cz" ], "type": "fixed", "uid": "bsh1621233459390Hxxx", "id": "1396481709372866xxx", "status": "enable" } ], "total": 1, "has_more": false }, "t": 1623052765596, "success": true }

Error code

See Error code.