Skip to content

Web SDK Reference

Andre Lafleur edited this page Dec 11, 2025 · 4 revisions

This page provides reference tables for constants, GUIDs, and enumerations used throughout the Web SDK.

Well-Known Entity GUIDs

Security Center uses specific GUIDs to identify system entities, partitions, groups, rules, and schedules:

System Entities

Entity GUID Description
SystemConfiguration 00000000-0000-0000-0000-000000000007 System configuration entity for system-wide settings, custom events, event-to-actions, and retention periods
Administrator 00000000-0000-0000-0000-000000000003 Built-in Administrator user account
Administrators 00000000-0000-0000-0000-000000000002 Built-in Administrators user group

Partitions

Entity GUID Description
Root Partition (Default) 00000000-0000-0000-0000-00000000000B Default root partition containing all entities by default

Cardholder Groups

Entity GUID Description
All Cardholders 00000000-0000-0000-0000-000000000008 Built-in group containing all cardholders

Access Rules

Entity GUID Description
All Open Rule 00000000-0000-0000-0000-00000000000A Built-in access rule that grants access to everyone
Lockdown Rule 00000000-0000-0000-0000-000000000009 Built-in access rule that denies access to everyone

Schedules

Entity GUID Description
Always Schedule 00000000-0000-0000-0000-000000000006 Built-in schedule that is always active (24/7/365)

Output Behaviors

Entity GUID Description
Normal Output Behavior 00000000-0000-0000-0000-00000000000F Default output behavior for normal operation
Active Output Behavior 00000000-0000-0000-0000-00000000000E Output behavior for active/triggered state

EntityType Enumeration

Complete list of all entity types available in Security Center. Use these values in queries, filters, and entity creation operations.

EntityType Value Create Delete Description
AccessPoint 1 Yes Yes Access point entity
AccessRule 2 Yes Yes Access rule entity
Alarm 3 Yes Yes Alarm entity
Application 4 No No Application entity
Area 5 Yes Yes Area entity
Camera 6 Yes Yes Camera entity
Cardholder 7 Yes Yes Cardholder entity
CardholderGroup 8 Yes Yes Cardholder group entity
Credential 9 Yes Yes Credential entity
Device 10 Yes Yes Device entity
Door 11 Yes Yes Door entity
Elevator 12 Yes Yes Elevator entity
Role 13 Yes Yes Role entity (units, servers, plugins)
OutputBehavior 14 No No Output behavior entity
Partition 15 Yes Yes Partition entity
SystemConfiguration 16 Yes No System configuration entity
Schedule 18 Yes Yes Schedule entity
Unit 19 Yes Yes Access control unit entity
User 20 Yes Yes User entity
UserGroup 21 Yes Yes User group entity
Visitor 22 Yes Yes Visitor entity
Zone 23 Yes Yes Zone entity
Macro 24 Yes Yes Macro entity
CashRegister 25 Yes Yes Cash register entity
LprUnit 27 Yes Yes License plate recognition unit entity
Patroller 28 Yes Yes Patroller entity
Permit 29 Yes Yes Permit entity
HotlistRule 30 Yes Yes LPR hotlist rule entity
OvertimeRule 31 No No LPR overtime rule entity
PermitRule 32 No No LPR permit rule entity
SharedPermitRule 33 No No LPR shared permit rule entity
UserTask 34 No No User task entity
IntrusionArea 35 Yes Yes Intrusion area entity
IntrusionUnit 36 Yes Yes Intrusion unit entity
Server 37 No No Server entity
Asset 38 Yes Yes Asset entity
VideoUnit 39 No No Video unit entity
File 40 No No File entity (audio, picture, etc.)
Monitor 41 Yes Yes Monitor entity (Security Desk)
ThreatLevel 43 Yes Yes Threat level entity
Stream 44 No No Stream entity
Network 45 No No Network entity
Agent 46 No No Agent entity
Route 47 No No Route entity
Badge 48 No No Badge template entity
Sequence 49 No No Camera sequence entity
TilePlugin 50 Yes Yes Tile plugin entity
LprMlpiRule 51 No No LPR parking facility rule entity
ScheduledTask 52 Yes Yes Scheduled task entity
AnalogMonitor 53 Yes Yes Analog monitor entity
AnalogMonitorGroup 54 Yes Yes Analog monitor group entity
Map 55 No No Map entity
ParkingZone 56 Yes Yes Parking zone entity (AutoVu)
ParkingRule 57 No No Parking rule entity (AutoVu)
CustomEntity 58 Yes Yes Custom entity defined by plugin
TileLayout 59 Yes Yes Tile layout entity
DoorTemplate 60 No No Door template entity
InterfaceModuleDeviceDefinition 61 No No Interface module device definition entity
InterfaceModule 62 Yes Yes Access control interface module entity
TransferGroup 63 No No Transfer group entity
EventFilterConfiguration 64 No No Event filter configuration entity

EventType Enumeration

Complete list of all system event types. Use these IDs when subscribing to events, filtering event streams, or raising custom events.

Event Name ID Can Raise Description
ManualAction 1 No Manual action event
AlarmTriggered 2 No Alarm triggered
AlarmAcknowledged 3 No Alarm acknowledged
ApplicationConnected 4 No Application connected
ApplicationDisconnected 5 No Application disconnected
CameraLiveBookmarkAdded 6 No Camera live bookmark added
CameraPlaybackBookmarkAdded 7 No Camera playback bookmark added
CameraMotionOn 8 Yes Camera motion detected
CameraMotionOff 9 Yes Camera motion stopped
CardholderAccessGranted 10 Yes Cardholder access granted
CardholderAccessRefused 11 Yes Cardholder access refused
CardholderInactive 13 No Cardholder inactive
CardholderAntipassback 14 No Cardholder antipassback violation
CustomEvent 15 Yes Custom event
UnitConnected 16 No Unit connected
UnitDisconnected 17 No Unit disconnected
UnitACFail 18 No Unit AC power failure
UnitBatFail 19 No Unit battery failure
UserLoggedOn 20 No User logged on
UserLoggedOff 21 No User logged off
DoorRexOn 22 Yes Door REX activated
DoorRexOff 23 Yes Door REX deactivated
DoorOpenedForTooLong 24 No Door opened for too long
DoorPullStationActivated 25 No Door pull station activated
DoorPullStationNormal 26 No Door pull station normal
DoorOpen 27 No Door opened
DoorClose 28 No Door closed
DoorLock 30 No Door locked
DoorUnlock 31 No Door unlocked
DoorOpenWhileLockSecure 32 No Door opened while lock secure
AccessUnknownCredential 33 Yes Access with unknown credential
AccessUnassignedCredential 34 Yes Access with unassigned credential
AccessGranted 35 Yes Access granted
AccessRefused 36 Yes Access refused
AccessExpiredCredential 37 Yes Access with expired credential
AccessStolenCredential 38 Yes Access with stolen credential
AccessLostCredential 39 Yes Access with lost credential
AccessInactiveCredential 40 Yes Access with inactive credential
AccessInactivePerson 41 Yes Access by inactive person
DoorTamper 42 No Door tampered
InputTroubleShort 43 No Input trouble (short circuit)
InputTroubleOpen 44 No Input trouble (open circuit)
AreaFirstManIn 45 No Area first person in
AreaLastManOut 46 No Area last person out
AreaAntipassbackDetected 47 No Area antipassback detected
AreaAntipassbackForgiven 48 No Area antipassback forgiven
CredentialUnassigned 49 No Credential unassigned
CredentialExpired 50 No Credential expired
CredentialStolen 51 No Credential stolen
CredentialLost 52 No Credential lost
CredentialInactive 53 No Credential inactive
ZoneGlassBreak 54 No Zone glass break
ZoneWindowOpened 55 No Zone window opened
ZoneWindowClosed 56 No Zone window closed
ZoneDeadBoltLocked 57 No Zone deadbolt locked
ZoneDeadBoltUnlocked 58 No Zone deadbolt unlocked
ZoneKnobInplace 59 No Zone knob in place
ZoneKnobRotated 60 No Zone knob rotated
ZoneLockSecured 61 No Zone lock secured
ZoneLockReleased 62 No Zone lock released
MacroStarted 63 No Macro started
MacroCompleted 64 No Macro completed
MacroAborted 65 No Macro aborted
PeopleCountReset 66 No People count reset
AreaCardholderRemoved 68 No Cardholder removed from area
AreaMaxOccupancyReached 69 Yes Area max occupancy reached
AreaMaxOccupancyExceeded 70 Yes Area max occupancy exceeded
AreaBelowMaxOccupancy 71 Yes Area below max occupancy
AreaDuressPinEntered 72 Yes Duress PIN entered at area
CardholderDuressPinEntered 73 Yes Duress PIN entered by cardholder
AreaEvacuationStarted 74 Yes Area evacuation started
AreaEvacuationEnded 75 Yes Area evacuation ended
AreaMusteringStarted 76 Yes Area mustering started
AreaMusteringEnded 77 Yes Area mustering ended
AreaCardholderAdded 80 No Cardholder added to area
AlarmAcknowledgedAlternate 81 No Alarm acknowledged (alternate)
AlarmConditionCleared 82 No Alarm condition cleared
AlarmContextChanged 83 No Alarm context changed
LprRead 256 No License plate read
LprHit 257 No License plate hit
ProcessMlpiResultsResultEvent 258 No MLPI results processed
LprOffloadSucceeded 259 No LPR offload succeeded
LprOffloadFailed 260 No LPR offload failed
LprNoMatch 261 No License plate no match
LprHotlistChanged 262 No LPR hotlist changed
IntrusionAreaDuress 512 No Intrusion area duress
IntrusionAreaEntryDelay 513 No Intrusion area entry delay
IntrusionAreaAlarmActivated 514 No Intrusion area alarm activated
IntrusionAreaArming 515 No Intrusion area arming
IntrusionAreaArmingPostponed 516 No Intrusion area arming postponed
IntrusionAreaMasterArmed 517 No Intrusion area master armed
IntrusionAreaPerimeterArmed 518 No Intrusion area perimeter armed
IntrusionAreaDisarmed 519 No Intrusion area disarmed
IntrusionAreaInputTrouble 520 No Intrusion area input trouble
IntrusionAreaInputBypassActivated 521 No Intrusion area input bypass activated
IntrusionAreaInputBypassDeactivated 522 No Intrusion area input bypass deactivated
IntrusionAreaForcedArming 523 No Intrusion area forced arming
IntrusionAreaCanceledAlarm 524 No Intrusion area alarm canceled
IntrusionAreaAlarmSilenced 530 No Intrusion area alarm silenced
ZoneArmed 768 No Zone armed
ZoneDisarmed 769 No Zone disarmed
ZoneMaintenanceOn 770 No Zone maintenance on
ZoneMaintenanceOff 771 No Zone maintenance off
ZoneWarningUnitOffline 772 No Zone warning unit offline
DoorMaintenanceOff 848 No Door maintenance off
DoorMaintenanceOn 849 No Door maintenance on
DoorScheduledLock 850 No Door scheduled lock
DoorScheduledUnlock 851 No Door scheduled unlock
DoorWarningUnitOffline 852 No Door warning unit offline
DoorManuallyUnlocked 853 No Door manually unlocked
DoorDoubleBadgeOn 854 Yes Door double badge activated
DoorDoubleBadgeOff 855 Yes Door double badge deactivated
CardholderDoubleBadgeOn 856 Yes Cardholder double badge activated
CardholderDoubleBadgeOff 857 Yes Cardholder double badge deactivated
CredentialDoubleBadgeOn 864 Yes Credential double badge activated
CredentialDoubleBadgeOff 865 Yes Credential double badge deactivated
SupervisorInAccessRuleActivated 866 No Supervisor in access rule activated
SupervisorInUnlockingScheduleActivated 867 No Supervisor in unlocking schedule activated
DoorOnline 868 No Door online
InterfaceOnline 869 No Interface online
InterfaceOffline 870 No Interface offline
DoorUnsecured 871 No Door unsecured
DoorSecured 872 No Door secured
EmergencyDoorRex 873 No Emergency door REX
EmergencyDoorUnlockPostponed 874 No Emergency door unlock postponed
EmergencyDoorUnlocked 875 No Emergency door unlocked
EmergencyDoorUnlockedOperatorUnlock 876 No Emergency door unlocked by operator
EmergencyDoorUnlockedReleaseDelayTimeExpired 877 No Emergency door unlocked (release delay expired)
EmergencyDoorUnlockedExtensionGuardLockingExpired 878 No Emergency door unlocked (extension guard locking expired)
EmergencyDoorUnlockedMaximumLockingTimeExpired 879 No Emergency door unlocked (max locking time expired)
EmergencyDoorUnlockedHostConnectionTimeout 880 No Emergency door unlocked (host connection timeout)
EmergencyDoorReset 881 No Emergency door reset
EmergencyDoorResetRemoteOperator 882 No Emergency door reset by remote operator
EmergencyDoorResetPhysicalButton 883 No Emergency door reset by physical button
EmergencyDoorResetAuto 884 No Emergency door auto reset
AccessControlUnitWarningActivated 885 No Access control unit warning activated
AccessControlUnitWarningDeactivated 886 No Access control unit warning deactivated
EmergencyDoorTestStarted 887 No Emergency door test started
EmergencyDoorTestSucceeded 888 No Emergency door test succeeded
EmergencyDoorTestFailed 889 No Emergency door test failed
EmergencyDoorTestFailedAborted 891 No Emergency door test failed (aborted)
EmergencyDoorTestFailedReaderShunted 892 No Emergency door test failed (reader shunted)
EmergencyDoorTestFailedDoorNotSecured 893 No Emergency door test failed (door not secured)
EmergencyDoorTestFailedError 894 No Emergency door test failed (error)
EmergencyDoorTestFailedUnlockFailed 895 No Emergency door test failed (unlock failed)
EmergencyDoorTestFailedRelockFailed 896 No Emergency door test failed (relock failed)
VideoAnalyticsAudioAlarm 1024 Yes Video analytics audio alarm
VideoAnalyticsLicensePlateInSight 1025 Yes Video analytics license plate in sight
VideoAnalyticsLicensePlateOutofSight 1026 Yes Video analytics license plate out of sight
VideoAnalyticsLicensePlateReading 1027 Yes Video analytics license plate reading
VideoAnalyticsObjectConditionChange 1028 Yes Video analytics object condition changed
VideoAnalyticsObjectCrossedLine 1029 Yes Video analytics object crossed line
VideoAnalyticsObjectEntered 1030 Yes Video analytics object entered
VideoAnalyticsObjectExited 1031 Yes Video analytics object exited
VideoAnalyticsObjectFall 1032 Yes Video analytics object fall
VideoAnalyticsObjectFollowingRoute 1033 Yes Video analytics object following route
VideoAnalyticsObjectInField 1034 Yes Video analytics object in field
VideoAnalyticsObjectLeft 1035 Yes Video analytics object left
VideoAnalyticsObjectLoitering 1036 Yes Video analytics object loitering
VideoAnalyticsObjectMerged 1037 Yes Video analytics object merged
VideoAnalyticsObjectRemoved 1038 Yes Video analytics object removed
VideoAnalyticsObjectRun 1039 Yes Video analytics object run
VideoAnalyticsObjectSlide 1040 Yes Video analytics object slide
VideoAnalyticsObjectSplit 1041 Yes Video analytics object split
VideoAnalyticsObjectStopped 1042 Yes Video analytics object stopped
VideoAnalyticsTailgating 1043 Yes Video analytics tailgating
VideoAnalyticsTampering 1044 Yes Video analytics tampering
VideoAnalyticsUndefined 1045 Yes Video analytics undefined
VideoAnalyticsFaceDetected 1046 Yes Video analytics face detected
VideoAnalyticsDirectionAlarm 1047 Yes Video analytics direction alarm
VideoAnalyticsAdaptiveMotion 1048 Yes Video analytics adaptive motion
VideoAnalyticsObjectCountReached 1049 Yes Video analytics object count reached
VideoAnalyticsCrowdDetected 1051 Yes Video analytics crowd detected
VideoAnalyticsFaceRecognized 1052 Yes Video analytics face recognized
VideoAnalyticsObjectDetected 1053 Yes Video analytics object detected
VideoAnalyticsHeatMapChanged 1054 Yes Video analytics heat map changed
VideoAnalyticsObjectVelocityChanged 1055 Yes Video analytics object velocity changed
VideoAnalyticsObjectDirectionChanged 1056 Yes Video analytics object direction changed
VideoAnalyticsObjectCountChanged 1057 Yes Video analytics object count changed
VideoAnalyticsPeopleCounting 1058 Yes Video analytics people counting
VideoAnalyticsPeopleCountingAlarm 1059 Yes Video analytics people counting alarm
VideoAnalyticsTamperingOff 1060 Yes Video analytics tampering off
VideoAnalyticsTemperatureDetectionOn 1061 No Video analytics temperature detection on
VideoAnalyticsTemperatureDetectionOff 1062 No Video analytics temperature detection off
VideoAnalyticsTemperatureDetectionAlarm 1063 No Video analytics temperature detection alarm
VideoAnalyticsCrowdSize 1064 Yes Video analytics crowd size
FloorAccess 1104 Yes Floor access
AccessPointAccessGrantConfirmationRequested 1105 Yes Access point access grant confirmation requested
IdentityValidationSucceeded 1106 No Identity validation succeeded
IdentityValidationSucceededBiometric 1107 Yes Identity validation succeeded (biometric)
IdentityValidationSucceededManual 1108 Yes Identity validation succeeded (manual)
IdentityValidationFailed 1109 No Identity validation failed
IdentityValidationFailedBiometricMismatch 1110 Yes Identity validation failed (biometric mismatch)
IdentityValidationFailedBiometricMissing 1111 Yes Identity validation failed (biometric missing)
IdentityValidationFailedManual 1112 Yes Identity validation failed (manual)
IdentityValidationFailedTimeout 1113 Yes Identity validation failed (timeout)
AssetMoved 1280 No Asset moved
AssetLowBattery 1281 No Asset low battery
AssetOffline 1282 No Asset offline
AssetOnline 1283 No Asset online
ArchivingStartedAutomatically 1360 No Archiving started automatically
ArchivingStoppedAutomatically 1361 No Archiving stopped automatically
ArchivingStartedManually 1362 No Archiving started manually
ArchivingStoppedManually 1363 No Archiving stopped manually
ArchivingStartedOnMotionEvent 1364 Yes Archiving started on motion event
ArchivingStoppedOnMotionEvent 1365 Yes Archiving stopped on motion event
ArchivingStartedByExternalSource 1366 No Archiving started by external source
ArchivingStoppedByExternalSource 1367 No Archiving stopped by external source
ArchivingStartedByAlarm 1368 No Archiving started by alarm
ArchivingStoppedByAlarm 1369 No Archiving stopped by alarm
ArchiveFileDeleted 1370 No Archive file deleted
CameraSignalLost 1371 No Camera signal lost
CameraSignalRecovered 1372 No Camera signal recovered
ArchivingQueueFull 1373 No Archiving queue full
CameraNotArchiving 1374 No Camera not archiving
CameraTransmissionLost 1375 No Camera transmission lost
CameraRtpPacketsLost 1376 No Camera RTP packets lost
CameraMultipleSourceDetected 1377 No Camera multiple source detected
CameraStartBlock 1378 No Camera start block
CameraStopBlock 1379 No Camera stop block
CameraTransmissionRecovered 1380 No Camera transmission recovered
CameraEdgeRecordingCommandTimeout 1381 No Camera edge recording command timeout
CameraEdgestorageFailure 1382 No Camera edge storage failure
CameraMotion 1383 Yes Camera motion
CameraEdgestorageEnabled 1384 No Camera edge storage enabled
UnitDiskActionError 1393 No Unit disk action error
UnitDiskFormatted 1394 No Unit disk formatted
UnitDiskLocked 1395 No Unit disk locked
UnitDiskMounted 1396 No Unit disk mounted
UnitDiskUnlocked 1397 No Unit disk unlocked
UnitDiskUnmounted 1398 No Unit disk unmounted
CameraArchiveTransferSequenceImported 1399 No Camera archive transfer sequence imported
CameraStartLiveStreaming 1400 No Camera start live streaming
CameraStopLiveStreaming 1401 No Camera stop live streaming
CameraFilesDeletedBeforeUploadBecauseDiskFull 1402 No Camera files deleted before upload (disk full)
CameraFilesDeletedBeforeUploadBecauseRetention 1403 No Camera files deleted before upload (retention)
PtzActivated 1536 No PTZ activated
PtzStopped 1537 No PTZ stopped
PtzZoomByUserStarted 1538 No PTZ zoom by user started
PtzZoomByUserStopped 1539 No PTZ zoom by user stopped
PtzLocked 1540 No PTZ locked
HealthMonitoringEvent 1792 No Health monitoring event
HealthMonitoringEventActiveAlarms 1793 No Health monitoring active alarms
HealthMonitoringEventActiveAlarmsRecovered 1794 No Health monitoring active alarms recovered
HealthMonitoringEventAgentStarted 1795 No Health monitoring agent started
HealthMonitoringEventAgentStopped 1796 No Health monitoring agent stopped
HealthMonitoringEventAgentStoppedUnexpectedly 1797 No Health monitoring agent stopped unexpectedly
HealthMonitoringEventAllArchivingRestarted 1798 No Health monitoring all archiving restarted
HealthMonitoringEventAllArchivingStopped 1799 No Health monitoring all archiving stopped
HealthMonitoringEventApplicationConnected 1800 No Health monitoring application connected
HealthMonitoringEventVideoSignalLoss 1801 No Health monitoring video signal loss
HealthMonitoringEventApplicationDisconnectedByUser 1802 No Health monitoring application disconnected by user
HealthMonitoringEventApplicationDisconnectedUnexpectedly 1803 No Health monitoring application disconnected unexpectedly

See Also

Security Center SDK


Macro SDK Developer Guide


Web SDK Developer Guide

  • Getting Started Setup, authentication, and basic configuration for the Web SDK.
  • Referencing Entities Entity discovery, search capabilities, and parameter formats.
  • Entity Operations CRUD operations, multi-value fields, and method execution.
  • Partitions Managing partitions, entity membership, and user access control.
  • Custom Fields Creating, reading, writing, and filtering custom entity fields.
  • Custom Card Formats Managing custom credential card format definitions.
  • Actions Control operations for doors, cameras, macros, and notifications.
  • Events and Alarms Real-time event monitoring, alarm monitoring, and custom events.
  • Incidents Incident management, creation, and attachment handling.
  • Reports Activity reports, entity queries, and historical data retrieval.
  • Performance Guide Optimization tips and best practices for efficient API usage.
  • Reference Entity GUIDs, EntityType enumeration, and EventType enumeration.
  • Under the Hood Technical architecture, query reflection, and SDK internals.
  • Troubleshooting Common error resolution and debugging techniques.

Media Gateway Developer Guide


Web Player Developer Guide

Clone this wiki locally