Allegion Developer Portal

Holiday_Records

Holiday Records

Holiday records are events that describe when a device should be put into a special state based upon a certain calendar date and time, overriding an auto-unlock schedule. A secured holiday puts the device into the normally secured state. A passage holiday puts the device into a normal passage state. The restricted secured holiday puts the device into a secured state, but the device only accepts 2 card types in this state, pass-through and freeze.

When in a restricted secured state if a freeze credential is presented, the device transitions from restricted secured to a normal secured state – allowing the expanded credential types to be allowed at the door. To restore the device to the restricted secured state, a freeze credential must be presented two more times the first takes the device to frozen secured state, the second triggers a schedule look-up causing the device to resume restricted secured state). The pass-through credential functions as expected, momentarily unlocking the door.

In the event that the existing holiday record needs to be deleted from the device, and not replaced with a new set of holidays, then an ID empty tag of “[]” is sent from the host. Holiday records must be explicitly defined for every database structure provided to the device, even if previously defined.

 

Holiday Record Fields

Tag

JSON Short Tag

Type/Length (ASCII bytes)

Value

Device Exclusions

Database Block

db

String/2

N/A

SC, MTB, MTKB

Holiday Block

holidays

String/8

N/A

SC, MTB, MTKB

Start Date / Time

strtDtTm

String /14 <Q1) should there be a space between "g /"? or should it be "String/14"> 

YYYYMMDDHHMMSS – “20131224000000”, Dec 24, 2013, 00:00:00 ( Midnight ) NOTE: NDE has resolution to the minute.

SC, MTB, MTKB

End Date / Time

endDtTm

String /14 <Q1) should there be a space between "g /"? or should it be "String/14">

YYYYMMDDHHMMSS – “20131227080000” Dec 27, 2013, 8:00:00 am NOTE: NDE has resolution to the minute.

SC, MTB, MTKB

Action

action

String/9

“pass”, “sec”, “rstrctSec”*

SC, MTB, MTKB rstrctSec not supported on RMRU

 

Example of Holiday Records (JSON)


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

{
  “db”:{
    "holidays": [
    {
     "strtDtTm": "20141223000000",
     "endDtTm": "20141227000000",
     "action": "pass"
    },
    {
     "strtDtTm": "20140703000000",
     "endDtTm": "20140705000000",
     "action": "rstrctSec"
    }
  ],
 }
}

 

Delete Holiday Records

There may be instances when holiday records need to be deleted from the device. The host must be able to provide a JSON data structure that permits this operation.

The following JSON structure represents how holiday records would be erased from the device during a database update.

{
 “db”:{
  "holidays": [],
 }
}

Last Modified: October 29, 2019