Query Reservation History

Last Updated on : 2023-06-15 05:47:41

Filter the reservation history by user ID, username, reservation status, or page number.

API address

GET: /v1.0/iot-03/seat-reservations

Request parameter

Parameter name	Type	IN	Required	Description
uid	String	query	false	The user ID.
user_name	String	query	false	The username.
area_id	String	query	false	The parent ID of the reserved seat.
seat_no	String	query	false	The number of the reserved seat.
start_time	Long	query	false	The start timestamp of the reservation.
end_time	Long	query	false	The end timestamp of the reservation.
page_size	Integer	query	false	The number of items returned per page.
page_no	Integer	query	false	The page number.
status_list	String	query	false	The status of a specified reservation, separated with commas (,). Valid values: `reserved`: reserved. `signed_in`: already signed in. `manually_cancel`: canceled manually.

Return parameter

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

Description of result

Parameter name	Type	Description
has_more	Boolean	Indicates whether additional data is available.
list	List	The list of seat reservation results.
total	Long	The total number of results.

Description of list

Parameter name	Type	Description
id	String	The reservation ID.
uid	String	The user ID.
user_name	String	The username.
seat_id	String	The seat ID.
seat_no	String	The seat number.
area_id	String	The ID of the area where the seat is located.
area_name	String	The name of the area where the seat is located.
status	String	The reservation status.
start_time	Long	The start time of the reservation.
end_time	Long	The end time of the reservation.

Request example

GET: /v1.0/iot-03/seat-reservations?uid=bsh16214309853020xxx&user_name=chxxxin22&area_id=1394999846179438xxx&seat_no=ceshi12&status_list=signed_in&start_time=1621409209996&end_time=1621526399999&page_size=2&page_no=4

Return example

{
    "result": {
        "list": [
            {
                "area_name": "ceshi12",
                "seat_id": "1394999880337850xxx",
                "user_name": "chxxxin22",
                "end_time": 1621526399999,
                "seat_no": "ceshi12",
                "area_id": "1394999846179438xxx",
                "start_time": 1621409209996,
                "uid": "bsh16214309853020xxx",
                "id": "1395214464898302xxx",
                "status": "signed_in"
            }
        ],
        "total": 1,
        "has_more": false
    },
    "t": 1623053363752,
    "success": true
}

Error code

For more information, see error code.

Prev DocSeat Reservation Management

Next DocCancel Reservation