Start emergency mode and open the locks

Open the locks in emergency mode for a specified duration. The unlock time must be within the range [0 - 604800] seconds.

• If the unlock time is set to 0, the lock will remain open indefinitely until explicitly canceled via the endpoint POST /access/general/lock/close/emergency.
• If the unlock time is set to a value between 1 and 604800 seconds, the lock will open for the specified duration and then close automatically.
• A value of 0 is a special case and should be used with caution to avoid unintended prolonged access.

application/json

Request Body required

• locks object[] required

  Lock settings after turning on emergency

  lock_number integer required

  Possible values: <= 2

  Lock number 0 - all locks, 1 - first lock, 2 - second lock

  unlock_time integer required

  Possible values: <= 604800

  Unlock time in seconds

Responses

• 200
• 400
• 401
• 403

---

OK

• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

• Only 0, 1, 2 indexes available for the lock number
• Unlock time should be in range [0, 604800] seconds

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Wrong index
• Wrong unlock time

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Only 0, 1, 2 indexes available for the lock number"
}

{
  "error": "Unlock time should be in range [1, 86400] seconds"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...