Allegion Developer Portal

Audit_Trail_Reporting

Audit Trail Reporting

To minimize the amount of data transfer time, the device only sends audits that have never been successfully transferred to the host. Appended to the end of an audit trail transmission is the device’s current value for the “nxtDbVerTS”. Appending this time stamp to the end of the audit trail block also ensures that the device and host are synchronized. If the JSON configuration tag “lockId” is changed, this tag will also be appended to the end of the audit trail transmission.

The table below describes an audit trail record JSON data structure.

 

Audit Trail Record Table

Tag

Short Tag

Type/Length (ASCII bytes)

Value

Device Exclusions

Audits

audits

String/6

N/A

 

Audit Trail Event

event

String/8

See separate document for Audit & Alert Definitions. <Q1: what & where is this document?>

MTB, MTKB

Time Stamp

time

String /14

“YYYYMMDDHHMMSS” YYYY = Year MM = Month ( 01 – 12 ) DD = Day ( 01 – 31 ) HH = Hour ( 00 – 23 ) MM = Minutes ( 00 – 59 ) SS = Seconds ( 00 – 59 ) Example: “20140809134522” means August 9, 2014, 1:45:22 pm

MTB, MTKB

Audit ID

auditId

String/3

0 – 255 (If “auditIDEn” tag = “T”)

MTB, MTKB

Next Database Version Time Stamp

nxtDbVerTS

String/18

Hexadecimal value, which starts with 0x, followed by 16 hex digits. (i.e. “0x08d16357eef73a69” )

MTB, MTKB

Lock ID

lockId

Unsigned Int/5

Door ID (0-65534) 65535 disables no tour on LE locks

RMRU, MTB, MTKB

 


Audit Trail

The following structure represents a JSON data structure for an audit trail block that contains 3 audits. Note that this data structure does not contain a parent tag. This is because audit trails are being requested by the host, therefore the data type is not needed.

{“audits”:[
       {
         "event":"1122334455",
         "time":20131113091752
       },
       {
         "event":"008A0000",
         "time":20131113092022
       },
       {
         "event":"00860000",
         "time":20131113092513
       }
],
“nxtDbVerTS”:”0x0873828198485981”}

 

Last Modified: October 28, 2019