Get Sign-in Settings

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

Query the sign-in settings. The returned result includes whether there is an access control device, whether a person can enter in advance, the sign-in method, whether and when the reservation is automatically canceled in case a person does not sign in within the specified time.

API address

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

Return parameter

Parameter name	Type	Description
result	SignVO

Description of result

Parameter name	Type	Description
access_flag	String	Indicates whether an access control system is used. Valid values: `Y`: yes. `N`: no.
access_time	Integer	Indicates that a person can enter the seat several minutes before the reserved time. Valid values: `15` and `30`.
sign_in_method	String	The sign-in method. Valid values: `QRCode`: QR code. `accessControl`: access control device. `noSignIn`: no sign-in is required.
auto_cancel_flag	String	Indicates whether a seat reservation is automatically canceled if the person does not sign in within the specified time. Valid values: `Y`: cancel automatically. `N`: do not cancel.
auto_cancel_time	Integer	The time to automatically cancel the reservation if the person does not sign in within the specified time after the reserved time. Valid values: `5`, `10`, and `15`. Unit: minutes.

Request example

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

Return example

{
    "result": {
        "auto_cancel_flag": "N",
        "access_flag": "N",
        "auto_cancel_time": 15,
        "sign_in_method": "noSignIn",
        "access_time": 30
    },
    "t": 1623048781449,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Seat Settings

Next DocCreate Sign-in Settings