Allegion Developer Portal

PUT_edgeDevices_{linkId}_config

PUT /edgeDevices/{linkId}/config

This resource is used to selectively push configuration changes to a specified linked edge device. The payload is the JSON object config as defined in the ENGAGE - JSON Data Structures document.

Gateway

The Gateway sends anything that is in the body to the linked edge device. This means that the Gateway does not error check the contents of this change. Error checking is done by the edge device, so the audit trails should be checked to validate configuration updates.

Notes

  1. For firmware versions 1.50.08 and later: if the edge device is not connected when the command is sent, the Gateway caches the message and tries to send it once the device reconnects. Firmware versions prior to this do not store the message if the device is disconnected when the HTTP request is received. This resource has a limit on the JSON body message size of 2kb. Minified JSON corresponding to the “config” tag as defined in the ENGAGE - JSON Data Structures document should fall well within this limit.
  2. For firmware versions 1.51.22 and later: the Gateway has implemented a 36 hour timeout on config messages that are not able to be transmitted successfully to the edge device. Check the edge device audits for successful processing of the JSON body.

Reader-Controller

This resource does not have a limit on the JSON body message size, but would accept JSON body messages in 2kb blocks, if desired.

Authentication

Basic: Unique credentials defined and accepted during setup.

Request

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

Type: path parameter

  • linkId = linked edge device identifier, as defined in the ENGAGE - JSON Data Structures document, section titled Gateway Edge Device Link List. For reader-controllers this is a constant dev00000.

Body

Type: application/json

  • config = parent tag + children as defined in the **ENGAGE - JSON Data Structures** document, section titled *Device Parameters*, sub-section *Modifiable Parameters*.

Example

  {"config":{"model":"","relock":3,"doorProp":20,"ada":30,"firstManIn":0,"dstEnable":1,"dstStart":"3022","dstEnd":"B012",
"battFail":"sec","bprEn":"T","rtcTime":null,"proxConfHID":"T","proxConfGE4001":"T","proxConfGE4002":"F","proxConfAWID":"T",
"proxConfGECASI":"T","uid14443":"F","mi14443":"T","noc14443":"T","uid15693":"T","iClsUID40b":"T"}}

Success Response(s)

HTTP status code: 200

  • The JSON body of the response was successfully sent to the requested edge device. Check the edge device audits for successful processing of the JSON body.

HTTP status code: 202

  • The edge device was not connected to the Gateway at the time that the resource was requested. The Gateway will continue to attempt to send the message once the device re-connects. Check the edge device audits for successful processing of the JSON body.