Allegion Developer Portal

Credential_Schedule_Records

Credential Schedule Records

Credential Schedule Records are used to describe a set of times when an individual credential can be granted access. These times are described by a specific day of the week and time, not by a specific calendar date. These records are stored in the device and are applied to individual user records through the “Credential Schedule” tag within individual user records.

Devices with Credential Readers

In order for a credential to have access to a device, at least one credential schedule must be programmed into the device. If an existing credential schedule needs to be deleted from the lock, then the host must send at least one credential schedule that allows access 24 hrs / day, 7 days a week. The credential schedules must be explicitly defined for every database structure provided to the lock, even if previously defined.

 

Credential Schedule Record

Tag

JSON Short Tag

Type/Length (ASCII bytes)

Value

Device Exclusions

Database Block

db

String/2

N/A

<R1: should be N/A or None>

Credential Schedule Block

schedules

String/9

N/A

RMRU, MTB, MTKB

Days

days

Array of String/2s

[ “Su”, “Mo”, “Tu”, “We”, “Th”, “Fr”,“Sa” ]

RMRU, MTB, MTKB

Start Hour

strtHr

Unsigned Int/2

Hour, where a start hour (Hr) can be 0-23.

RMRU, MTB, MTKB

Start Minute

strtMn

Unsigned Int/2

Minute, where Minute can be 0-59.

RMRU, MTB, MTKB

Length

lngth

Unsigned Int/4

Duration of the schedule, in minutes (decimal), (1 – 1439). Value 1439 represents 23:59:59. All other values represent the minute. Value 1438 represents 23:58:00. Value 479 represents 7:59:00. 

RMRU, MTB, MTKB

Authentication Mode

auth

String/4

"1f" (default), "2f", "2fx2"

CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB

 

Example of Credential Schedule Records (JSON)

The following JSON data structure represents how the data structure might look if the credential schedule records were being sent to the device.

{
  “db”: {
   "schedules": [
   {
    "days": ["Su","Mo","Tu","We","Th",”Fr","Sa"],
    "strtHr": 0,
    "strtMn": 0,
    "lngth": 1439
   },
   {
    "days": ["Mo","Tu","We","Th","Fr"],
    "strtHr": 8,
    "strtMn": 0,
    "lngth": 540
   },
   {
    "days": ["Mo","We","Fr"],
    "strtHr": 8,
    "strtMn": 0,
    "lngth": 240
   }
  ],
 }
}

Last Modified: October 29, 2019