Events
Request events.
Type: Events
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Events&SubType=<SubType>SubTypes
|
SubType |
Description |
|---|---|
|
Update |
All events since last request |
|
Latest |
Last 20 events |
|
Previous |
Previous 20 events from last request |
|
Next |
Next 20 events from last request |
|
ExportCSV |
Export events to a CSV file. For details see ExportCSV below. |
Success Response
A successful response contains the ampersand separated list of events.
Event0=Mon 02/01/2006 11:44:18 System Power Up &Event1=Mon 02/01/2006 11:44:18 Module RD001 Registered (C25399CA)&Event2=Mon 02/01/2006 11:44:18 Trouble Input Bell Siren 1 Tamper / Cut Opened &Event3=Mon 02/01/2006 11:44:26 Time Work Hours Schedule Valid &Event4=Mon 02/01/2006 11:44:26 Trouble Input System Restarted Opened &Event5=Mon 02/01/2006 11:44:26 Trouble Input System Restarted Closed &Event6=Mon 02/01/2006 11:44:28 Area System Area Force Arming Started By SYSTEM USER Using AR241 &Event7=Mon 02/01/2006 11:44:28 Area System Area 24Hr Enabled By SYSTEM USER &Event8=Mon 02/01/2006 11:44:28 Report In System Area Trouble Input Bell Siren 1 Tamper / Cut [FF] [TP]&Event9=Mon 02/01/2006 11:44:28 Area System Area Alarm Activated &Event10=Mon 02/01/2006 11:44:28 Area Area 1 24Hr Enabled By SYSTEM USER &Event11=Mon 02/01/2006 11:44:28 Area System Area Force Armed By SYSTEM USER &Event12=Mon 02/01/2006 11:44:28 Report In System Area Area SYSTEM USER [REMOTE+SYSTEM] [AR+RES]&Event13=Mon 02/01/2006 11:44:29 Module RD001 Online &EventCodes0=2964377922,0,0,0,0,0,0,0,0,0,0,0,0,0&EventCodes1=2964377922,2304,1044,4,1045,0,1070,194,0,83,1070,153,0,202&EventCodes2=2964377922,1281,1035,198,0,0,0,0,0,0,0,0,0,0&EventCodes3=2964377922,1792,1018,0,0,0,0,0,0,0,0,0,0,0&EventCodes4=2964377922,1281,1035,217,0,0,0,0,0,0,0,0,0,0&EventCodes5=2964377922,1280,1035,217,0,0,0,0,0,0,0,0,0,0&EventCodes6=2964377922,2122,1014,0,1016,4294967294,0,0,0,2147483632,0,0,0,0&EventCodes7=2964377922,2211,1014,0,1016,4294967294,0,0,0,2147483632,0,0,0,0&EventCodes8=2964377922,40961,1014,0,1035,198,0,0,1108,255,0,0,1061,1&EventCodes9=2964377922,2111,1014,0,0,0,0,0,0,0,0,0,0,0&EventCodes10=2964377922,2211,1014,16,1016,4294967294,0,0,0,2147483632,0,0,0,0&EventCodes11=2964377922,2089,1014,0,1016,4294967294,0,0,0,2147483632,0,0,0,0&EventCodes12=2964377922,40962,1014,0,1016,4294967294,0,4294967295,1062,87,0,0,1061,11&EventCodes13=2964377922,2305,1044,4,1045,0,0,0,0,0,0,0,0,0Any valid request that contains no events will return the following.
<no response>The maximum length of each event description is 1024 characters. Longer event descriptions will be truncated.
Response Parameters
The first part is the event descriptions with keys Event<Event ID>. The second part provides additional event data, including the event timestamp and event code. It has the keys EventCodes<Event ID>.
Additional Event Data
|
Event Data |
Example |
Description |
|---|---|---|
|
Timestamp |
880939147 |
Timestamp of the event. |
|
Event Code |
3093 |
A unique code for each event type. These are documented in the appendix: Event Codes. |
|
Service_ServiceErrorCode |
1000,1 |
1000, followed by the Record ID. |
|
Modem_ConnectionType |
1001,1 |
1001, followed by the Record ID. |
|
Modem_ModbusExceptionErrorType |
1002,1 |
1002, followed by the Record ID. |
|
User_EntryExitModeErrorCode |
1003,1 |
1003, followed by the Record ID. |
|
User_ReadingDevice |
1004,1 |
1004, followed by the Record ID. |
|
User_UnlockMode |
1005,1 |
1005, followed by the Record ID. |
|
User_TroubleGroupTypes |
1006,1 |
1006, followed by the Record ID. |
|
User_GeneralTypes |
1007,1 |
1007, followed by the Record ID. |
|
User_SystemTypes |
1008,1 |
1008, followed by the Record ID. |
|
PGM_AreaFunction |
1009,1 |
1009, followed by the Record ID. |
|
PGM_DoorFunction |
1010,1 |
1010, followed by the Record ID. |
|
Door_AccessMode |
1011,1 |
1011, followed by the Record ID. |
|
Reader_FormatErrorCode |
1012,1 |
1012, followed by the Record ID. |
|
Reader_ReadErrorCode |
1013,1 |
1013, followed by the Record ID. |
|
Area1 |
1014,1 |
1014, followed by the Record ID. |
|
Area2 |
1015,1 |
1015, followed by the Record ID. |
|
User |
1016,1 |
1016, followed by the Record ID. |
|
Door |
1017,1 |
1017, followed by the Record ID. |
|
Schedule |
1018,1 |
1018, followed by the Record ID. |
|
Keypad1 |
1019,1 |
1019, followed by the Record ID. |
|
Keypad2 |
1020,1 |
1020, followed by the Record ID. |
|
Service1 |
1021,1 |
1021, followed by the Record ID. |
|
Service2 |
1022,1 |
1022, followed by the Record ID. |
|
PhoneNumber |
1023,1 |
1023, followed by the Record ID. |
|
Reader |
1024,1 |
1024, followed by the Record ID. |
|
Beam |
1025,1 |
1025, followed by the Record ID. |
|
Interlock |
1026,1 |
1026, followed by the Record ID. |
|
Elevator |
1027,1 |
1027, followed by the Record ID. |
|
FloorGroup |
1028,1 |
1028, followed by the Record ID. |
|
Zone |
1029,1 |
1029, followed by the Record ID. |
|
Operator |
1030,1 |
1030, followed by the Record ID. |
|
AccessLevel |
1031,1 |
1031, followed by the Record ID. |
|
PgmGroup |
1032,1 |
1032, followed by the Record ID. |
|
ZoneType |
1033,1 |
1033, followed by the Record ID. |
|
Automation |
1034,1 |
1034, followed by the Record ID. |
|
TroubleZone |
1035,1 |
1035, followed by the Record ID. |
|
DoorGroup |
1036,1 |
1036, followed by the Record ID. |
|
Module |
1037,1 |
1037, followed by the Record ID. |
|
MenuGroup |
1038,1 |
1038, followed by the Record ID. |
|
Quantity |
1039,1 |
1039, followed by the Record ID. |
|
CRC |
1040,1 |
1040, followed by the Record ID. |
|
Message |
1041,1 |
1041, followed by the Record ID. |
|
MenuType |
1042,1 |
1042, followed by the Record ID. |
|
DoorType |
1043,1 |
1043, followed by the Record ID. |
|
ModuleType |
1044,1 |
1044, followed by the Record ID. |
|
ModuleAddress |
1045,1 |
1045, followed by the Record ID. |
|
ReaderPort |
1046,1 |
1046, followed by the Record ID. |
|
ReaderMode |
1047,1 |
1047, followed by the Record ID. |
|
KeypadAddress |
1048,1 |
1048, followed by the Record ID. |
|
User2 |
1049,1 |
1049, followed by the Record ID. |
|
PGM |
1050,1 |
1050, followed by the Record ID. |
|
Holiday |
1051,1 |
1051, followed by the Record ID. |
|
HolidayValidMask |
1052,1 |
1052, followed by the Record ID. |
|
PortNumber |
1053,1 |
1053, followed by the Record ID. |
|
RequiredVersion |
1054,1 |
1054, followed by the Record ID. |
|
SentVersion |
1055,1 |
1055, followed by the Record ID. |
|
MaxAddress |
1056,1 |
1056, followed by the Record ID. |
|
DeviceModule |
1057,1 |
1057, followed by the Record ID. |
|
DeviceAddress |
1058,1 |
1058, followed by the Record ID. |
|
DevicePortNumber |
1059,1 |
1059, followed by the Record ID. |
|
ReportCode |
1060,1 |
1060, followed by the Record ID. |
|
ReportingFlagsA |
1061,1 |
1061, followed by the Record ID. |
|
AreaReportType |
1062,1 |
1062, followed by the Record ID. |
|
AreaReportObjectType |
1063,1 |
1063, followed by the Record ID. |
|
Door2 |
1064,1 |
1064, followed by the Record ID. |
|
DebugCode |
1065,1 |
1065, followed by the Record ID. |
|
DebugSubCode |
1066,1 |
1066, followed by the Record ID. |
|
AssertionCode |
1067,1 |
1067, followed by the Record ID. |
|
DebugData |
1068,1 |
1068, followed by the Record ID. |
|
DataABCD |
1069,1 |
1069, followed by the Record ID. |
|
SerialNumber |
1070,1 |
1070, followed by the Record ID. |
|
ZoneRefType |
1071,1 |
1071, followed by the Record ID. |
|
ZoneRef1 |
1072,1 |
1072, followed by the Record ID. |
|
ZoneRef2 |
1073,1 |
1073, followed by the Record ID. |
|
ReportingFlagsB |
1074,1 |
1074, followed by the Record ID. |
|
User_AccessTypes |
1075,1 |
1075, followed by the Record ID. |
|
RecordType |
1076,1 |
1076, followed by the Record ID. |
|
RecordName |
1077,1 |
1077, followed by the Record ID. |
|
RecordIndex |
1078,1 |
1078, followed by the Record ID. |
|
Condominiums |
1079,1 |
1079, followed by the Record ID. |
|
CondoPartition |
1080,1 |
1080, followed by the Record ID. |
|
CondoUser |
1081,1 |
1081, followed by the Record ID. |
|
CondoZone |
1082,1 |
1082, followed by the Record ID. |
|
ElevatorGroup |
1083,1 |
1083, followed by the Record ID. |
|
Floor |
1084,1 |
1084, followed by the Record ID. |
|
ProgFunctions |
1085,1 |
1085, followed by the Record ID. |
|
Variables |
1086,1 |
1086, followed by the Record ID. |
|
AreaGroups |
1087,1 |
1087, followed by the Record ID. |
|
Data8 |
1088,1 |
1088, followed by the Record ID. |
|
Data16 |
1089,1 |
1089, followed by the Record ID. |
|
Data32 |
1090,1 |
1090, followed by the Record ID. |
|
NZData8 |
1091,1 |
1091, followed by the Record ID. |
|
NZData16 |
1092,1 |
1092, followed by the Record ID. |
|
NZData32 |
1093,1 |
1093, followed by the Record ID. |
|
AnalogModule |
1094,1 |
1094, followed by the Record ID. |
|
DaylightSavings |
1095,1 |
1095, followed by the Record ID. |
|
ZoneExpanders |
1096,1 |
1096, followed by the Record ID. |
|
ReaderExpanders |
1097,1 |
1097, followed by the Record ID. |
|
PGMExpanders |
1098,1 |
1098, followed by the Record ID. |
|
AnalogExpanders |
1099,1 |
1099, followed by the Record ID. |
|
DataValues |
1100,1 |
1100, followed by the Record ID. |
|
BitDataValues |
1101,1 |
1101, followed by the Record ID. |
|
HolidayGroup |
1102,1 |
1102, followed by the Record ID. |
|
Reserved |
1103 |
|
|
DVRs |
1104,1 |
1104, followed by the Record ID. |
|
SaltoDoor |
1105,1 |
1105, followed by the Record ID. |
|
User_CardIndex |
1106,1 |
1106, followed by the Record ID. |
|
Reserved |
1107 |
|
|
CustomReportType |
1108,1 |
1108, followed by the Record ID. |
|
Reserved |
1109 |
|
|
Reserved |
1110 |
|
|
SmartReader |
1111,1 |
1111, followed by the Record ID. |
|
Reserved |
1112 - 1115 |
|
|
Controller |
1116,1 |
1116, followed by the Record ID. |
|
Reserved |
1117 - 1176 |
|
|
Conditional |
1177,1 |
1177, followed by the Record ID. |
|
Conditional_ErrorCode |
1178,1 |
1178, followed by the Record ID. |
|
Controller2 |
1179,1 |
1179, followed by the Record ID. |
|
ShiftTypes |
1180,1 |
1180, followed by the Record ID. |
|
CredentialType |
1181,1 |
1181, followed by the Record ID. |
|
CredentialDataString |
1254,1 |
1254, followed by the Record ID. Not used in Protege WX. |
|
Reserved |
0,0 |
|
Errors
Request Failed (2) Did not get a response from the main app.Request Failed (3) Did not recognise the response from the main app.Request Failed (128) Event Request type not recognised.ExportCSV
Export events to CSV file, using the optional StartDate and EndDate parameters.
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Events&SubType=ExportCSV&StartDate=01-01-2017T00:00:00&EndDate=31-12-2017T23:59:00Request Parameters
|
Parameter |
Example |
Description |
|---|---|---|
|
StartDate |
01-01-2017T00:00:00 |
Optional. ISO 8601 format date. |
|
EndDate |
31-12-2017T23:59:59 |
Optional. ISO 8601 format date. |
Success Response
Successful response will return the CSV file with the requested events. If no events are found the file will contain only the CSV header.
CSV file name that is returned:
Event report <Controller Serial Number>.csvExport Errors
Request Failed (1) Could not open the Events request file.Request Failed (2) The file length was either 0 or too large.Request Failed (3) Could not allocate enough memory to process this.Request Failed (4) Could not read from NandFlash.Request Failed (11) Invalid dates were specified.Request Failed (14) Could not allocate memory to format the file.Request Failed (15) Could not create the file on NandFlash.Request Failed (16) Internal error - pointer corruption.Request Failed (20) Did not get a response from the main app.Request Failed (21) Got a response from the app but it was not for this command.