Allegion Developer Portal

PUT_edgeDevices_{linkId}_lockControl

PUT /edgeDevices/{linkId}/lockControl

This resource is a lock control command to a specific lock in the edgeDevice list. This command puts the edge device into the commanded state until a recalculation of state events occurs (unless the commanded state is a frozen state). This recalculation of state events 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.

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 will 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 the edge device is connected to the Gateway

Authentication

Basic: Unique credentials defined and accepted during setup.

Request

URI Parameters: <missing or is this 'None'?>

  • None <what is this referencing?>

Body: <missing or is this 'None'?>

Type: application/json

  • lockControl = parent tag + children tags, definition in 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: <missing or is this 'None'?>

  • None <what is this referencing?>

HTTP status code: 202

Type: application/json

  • statusMessage = “Command cached”, indicates the target edge device is not currently connected to Gateway, and the message will be delivered upon reconnection. Not applicable to reader-controllers.

Error Response(s)

HTTP status code: 400

Response parameters: <missing or is this '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 is this 'None'?>

Type: application/json

  • statusMessage = “Lock offline, momentary unlock command is not executed for, deviceId[(list)]”, indicates momentary unlock command was not delivered due to the edge device not being currently connected to Gateway.  Not applicable to reader-controllers.

 

Last Modified: October 16, 2019