PUT /edgeDevices/lockControl

This resource sends a broadcast lock control command to all locks in the linkList that support the lock control command issued. This command puts the edge device into the commanded state until a recalculation of state event occurs (unless the commanded state is a frozen state). This recalculation of state event occurs whenever a special credential (lockdown, toggle, etc.) is presented or a holiday, auto-unlock, or time change is sent to the edge device.

The body of the command is the JSON object lockControl as defined in the ENGAGE - JSON Data Structures document.

Notes

1. When sending lockControl HTTP requests, edge device audits should be consulted to ensure the edge device was able to receive the request and has transitioned into the requisite state.
2. This resource is not applicable to the reader-controller.

Change in functionality for URI

Gateway FW versions: Prior to 1.24: If the edge devices are configured with their own access control database and they are not wirelessly connected to the Gateway when this command is issued, the Gateway does not store the lock control command.

Gateway FW versions: 1.24 to latest: Lock state change commands are now cached in the Gateway and delivered upon reconnect to the edge device. Exception: Momentary unlock commands are not cached in the Gateway. Momentary unlock messages can only be delivered when edge device is connected to the Gateway.

Authentication

Basic: Unique credentials defined and accepted during setup.

Request

URI Parameters: None

Body: <missing body or should this be 'None'?>

Type: application/json

• lockControl = parent tag + children tags, definition in the ENGAGE - JSON Data Structures document, section titled “Device Control” related to the Gateway structures

Example:

{"lockControl":{"lockState":{"nextLockState":"frozenSecure"}}}

Success Response(s)

HTTP status code: 200

Response parameters: None

HTTP status code: 202

Type: application/json

• statusMessage = “Command cached for, deviceId: [(list)]”, indicates that one or more of the edge devices are currently disconnected from the Gateway. The list is contained in the ordered array.

Error Response(s)

HTTP status code: 400

Response parameters: <missing or should this be 'None'?>

Type: application/json

• statusMessage = multiple detailed status message, value(s) defined below

  • “Relock delay out of bounds” indicates, relock delay sent in JSON body is out of bounds

  • “Invalid JSON tag” indicates, invalid tag name sent in JSON body

  • “Invalid JSON tag value”, indicates, invalid tag value in JSON body

HTTP status code: 409

Response parameters: <missing or should this be 'None'?>

Type: application/json

• statusMessage = “Lock(s) offline, momentary unlock command is not executed for, deviceId[(list)]”, indicates momentary unlock command sent to locks currently connected, however momentary unlock messages are not cached.

Last Modified: October 15, 2019