Database Overview

During a connected event when a device is either requesting a database update from the host directly over WiFi/Ethernet or when the database is being updated via BLE, the device can receive a database update. The database received by the device can contain user records, credential schedules, holidays, and auto unlock data sent by the host. The database consists of several different sub-components. The sub-components are user records, holidays, user schedules and auto unlock events. The parent tag of the database is expressed with the JSON “db” tag. From these sub-components, only individual user records can be modified during a database update. This is accomplished through the “deleteAll, “delete”, “update” and “add” tags.

If the holidays, user schedules or auto unlock records need to be added or updated, the records should be sent as a whole. For these records, no individual records can be deleted or updated. When the holidays or auto unlock records need to be completely erased from the lock, the tag is sent with an empty “[ ]” collection. (i.e. “holidays”: [ ] or “autoUnlock”: [ ]) When a database update occurs for devices with user credential capabilities, at least one credential schedule must always be sent with the default schedule of access 24 hrs x 7 days / week. An empty collection for credential schedules is not possible. If the host fails to send the default 24x7 credential schedule, even valid credentials will not gain access. Configurations can also be included with the database but they use a separate JSON parent tag structure.

Last Modified: October 23, 2019