Create Sign-in Settings

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

Create the sign-in settings, including the sign-in method, whether and when the reservation is automatically canceled in case a person does not sign in within the specified time, and when a person can enter in advance.

API address

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

Request parameter

Description of body

Parameter name	Type	Required	Description
access_flag	String	true	Indicates whether an access control system is used. Valid values: `Y`: yes. `N`: no.
access_time	Integer	true	Indicates that a person can enter the seat several minutes before the reserved time. Valid values: `15` and `30`.
sign_in_method	String	true	The sign-in method. Valid values: `QRCode`: QR code. `accessControl`: access control device. `noSignIn`: no sign-in is required.
auto_cancel_flag	String	true	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	true	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.

Return parameter

Parameter name	Type	Description
result	Boolean	Indicates whether the operation is successful. Valid values: `true`: succeeded. `false`: failed.

Request example

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

{
  "access_flag": "N",
  "access_time": 30,
  "auto_cancel_flag": "N",
  "auto_cancel_time": 15,
  "sign_in_method": "noSignIn"
}

Return example

{
    "result": true,
    "t": 1623048906879,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Sign-in Settings

Next DocCreate Seat Settings