-
Notifications
You must be signed in to change notification settings - Fork 4
web sdk reference
Andre Lafleur edited this page Mar 4, 2026
·
3 revisions
This page provides reference tables for constants, GUIDs, and enumerations used throughout the Web SDK.
Security Center uses specific GUIDs to identify system entities, partitions, groups, rules, and schedules:
| 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 |
| Entity | GUID | Description |
|---|---|---|
| Root Partition (Default) | 00000000-0000-0000-0000-00000000000B |
Default root partition containing all entities by default |
| Entity | GUID | Description |
|---|---|---|
| All Cardholders | 00000000-0000-0000-0000-000000000008 |
Built-in group containing all cardholders |
| 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 |
| Entity | GUID | Description |
|---|---|---|
| Always Schedule | 00000000-0000-0000-0000-000000000006 |
Built-in schedule that is always active (24/7/365) |
| 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 |
These GUIDs identify the standard card formats built into Security Center. Use them when creating or querying credentials with a specific card format.
| Card Format | GUID | Description |
|---|---|---|
| Raw | 00000000-0000-0000-0000-000000000000 |
Raw card data (no decoding) |
| Wiegand 26-bit | 00000000-0000-0000-0000-000000000200 |
Standard 26-bit Wiegand format |
| Wiegand H10306 | 00000000-0000-0000-0000-000000000300 |
HID H10306 34-bit Wiegand format |
| Wiegand H10302 | 00000000-0000-0000-0000-000000000400 |
HID H10302 37-bit Wiegand format |
| Wiegand H10304 | 00000000-0000-0000-0000-000000000500 |
HID H10304 37-bit Wiegand format with facility code |
| Corporate 1000 | 00000000-0000-0000-0000-000000000600 |
HID Corporate 1000 35-bit format |
| CSN 32-bit | 00000000-0000-0000-0000-000000000700 |
32-bit Card Serial Number format |
| Corporate 1000 48-bit | 00000000-0000-0000-0000-000000000800 |
HID Corporate 1000 48-bit format |
| FASC-N 75-bit | 00000000-0000-0000-0000-000000000900 |
Federal Agency Smart Credential Number 75-bit format |
| FASC-N 200-bit | 00000000-0000-0000-0000-000000000A00 |
Federal Agency Smart Credential Number 200-bit format |
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 | No | 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 | No | Yes | Device entity |
| Door | 11 | Yes | Yes | Door entity |
| Elevator | 12 | Yes | Yes | Elevator entity |
| Role | 13 | Yes | No | Role entity (units, servers, plugins) |
| OutputBehavior | 14 | No | No | Output behavior entity |
| Partition | 15 | Yes | Yes | Partition entity |
| SystemConfiguration | 16 | No | 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 | No | 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 | No | No | 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 | No | 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 | Yes | Yes | Parking rule entity (AutoVu) |
| CustomEntity | 58 | Yes | Yes | Custom entity defined by plugin |
| TileLayout | 59 | Yes | Yes | Tile layout entity |
| DoorTemplate | 60 | Yes | Yes | Door template entity |
| InterfaceModuleDeviceDefinition | 61 | No | No | Interface module device definition entity |
| InterfaceModule | 62 | No | Yes | Access control interface module entity |
| TransferGroup | 63 | Yes | Yes | Transfer group entity |
| EventFilterConfiguration | 64 | No | No | Event filter configuration entity |
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 |
Values for the Type property when creating a Role entity. Set Type in the same request as NewEntity(Role).
| RoleType | Value | Description |
|---|---|---|
| ActiveDirectory | 1 | Active Directory integration |
| Omnicast | 2 | Omnicast federation (4.x) |
| SecurityCenter | 3 | Security Center federation |
| MediaRouter | 4 | Media Router |
| Archiver | 5 | Archiver |
| WebSdk | 6 | Web SDK |
| Plugin | 7 | Plugin |
| LicensePlateManagement | 8 | License Plate Management (AutoVu) |
| IntrusionDetection | 9 | Intrusion Detection |
| AccessManager | 10 | Access Manager |
| ZoneManagement | 12 | Zone Manager |
| TaskAutomation | 13 | Task Automation (Scheduled Tasks) |
| Audit | 14 | Audit Trail |
| HealthMonitoring | 15 | Health Monitor |
| AuxiliaryArchiver | 16 | Auxiliary Archiver |
| DirectoryFailover | 17 | Directory Failover |
| SharingManager | 18 | Sharing Manager |
| MediaProxy | 19 | Media Proxy (cloud streaming) |
| PortalCoordinator | 20 | Stratocast Coordinator |
| RtspMediaRouter | 22 | RTSP Media Router |
| IncidentManager | 23 | Incident Manager (Mission Control) |
| PrivacyProtector | 24 | Privacy Protector |
| UnitAssistant | 25 | Unit Assistant |
| RecordFusionService | 26 | Record Fusion Service |
| RecordFusionCachingService | 27 | Record Fusion Caching Service |
| MobileCredentialManager | 28 | Mobile Credential Manager |
| CloudArchiveRole | 29 | Cloud Archive |
| BwcManager | 30 | Body-Worn Camera Manager |
| WebAppServer | 31 | Web App Server |
| ReverseTunnelClient | 32 | Reverse Tunnel Client |
| MapManagement | 33 | Map Manager |
| MobileServer | 34 | Mobile Server |
| ReverseTunnelServer | 35 | Reverse Tunnel Server |
| AutomationManager | 36 | Automation Manager |
| Value | Description |
|---|---|
| Permanent | Permanent access rule (default) |
| Temporary | Temporary access rule |
| Value | Description |
|---|---|
| None | Alarm state not defined |
| Active | Alarm is active |
| Acked | Alarm has been acknowledged |
| SourceConditionInvestigating | Alarm with source condition is being investigated |
| AknowledgeRequired | Alarm is waiting to be acknowledged after source condition cleared |
| Value | Description |
|---|---|
| Active | Cardholder is active |
| Inactive | Cardholder is inactive |
| Expired | Cardholder is expired |
| Value | Description |
|---|---|
| Active | Credential is active |
| Expired | Credential is expired |
| Inactive | Credential is inactive |
| Lost | Credential is lost |
| Stolen | Credential has been stolen |
| Requested | Credential has been requested |
| Value | Description |
|---|---|
| None | Not specified |
| Keypad | Input by keypad |
| UndecodedWiegand | Undecoded Wiegand card |
| LicensePlate | License plate recognition |
| CardRequest | Card request |
| Value | Description |
|---|---|
| None | Not specified |
| Reader | Card reader |
| Input | Input device |
| Output | Output device |
| Lpr | License plate reader |
| VideoEncoder | Video encoder |
| Serial | Serial device |
| AlarmPanelInput | Alarm panel input |
| AlarmPanelOutput | Alarm panel output |
| AudioDecoder | Audio decoder |
| AudioEncoder | Audio encoder |
| VideoUnitInput | Video unit input |
| VideoUnitOutput | Video unit output |
| AnalogMonitor | Analog monitor |
| Value | Description |
|---|---|
| None | Standard door |
| Mobile | Mobile door |
| Offline | Offline door |
| Value | Description |
|---|---|
| Unknown | State not known |
| Normal | Normal state |
| Active | Active state |
| TroubleShort | Short trouble |
| TroubleOpen | Open trouble |
| Unavailable | Input unavailable |
| TroubleOff | Trouble off |
| Value | Description |
|---|---|
| Unknown | State not known |
| Normal | Normal state |
| Active | Active state |
| Value | Description |
|---|---|
| Off | No archiving |
| Continuous | Continuous archiving |
| OnMotionOrManual | Archiving on motion detection or manual trigger |
| Manual | Manual archiving only |
| Value | Description |
|---|---|
| OffLocked | Not recording, mode is on-motion |
| Off | Not recording |
| OnLocked | Recording, mode is on-motion |
| On | Recording |
| OnAboutToStop | About to stop recording |
| Problem | Not archiving due to archiver problem |
Entity running state. Returned by the RunningState property on all entities.
| Value | Description |
|---|---|
| Running | Entity is running |
| NotRunning | Entity is not running |
| Warning | Entity is in warning state |
| Value | Description |
|---|---|
| Activated | User is activated |
| Deactivated | User is deactivated |
| Value | Description |
|---|---|
| Active | Zone is active |
| Normal | Zone is normal |
| Trouble | Zone is troubled |
| Unknown | Zone state is unknown |
- Events and Alarms Guide - Complete guide to event monitoring and alarm management
- Entity Operations - Working with entities using EntityType filters
- Partitions - Understanding partition GUIDs and entity membership
- Getting Started - Basic Web SDK setup and configuration
-
Security Center SDK Developer Guide Overview of the SDK framework and how to build integrations with Security Center.
-
Platform SDK
- Overview Introduction to the Platform SDK and core concepts.
- Connecting to Security Center Step-by-step guide for connecting and authenticating with the SDK.
- SDK Certificates Details certificates, licensing, and connection validation.
- Referencing SDK Assemblies Best practices for referencing assemblies and resolving them at runtime.
- SDK Compatibility Guide Understanding backward compatibility and versioning in the SDK.
- Entity Guide Explains the core entity model, inheritance, and how to work with entities.
- Entity Cache Guide Describes the engine's local entity cache and synchronization.
- Transactions Covers batching operations for performance and consistency.
- Events Subscribing to real-time system events.
- Actions Sending actions to Security Center.
- Security Desk Displaying content on monitors, reading tiles, sending tasks, and messaging operators.
- Custom Events Defining, raising, and subscribing to custom events.
- ReportManager Querying entities and activity data from Security Center.
- ReportManager Query Reference Complete reference of query types, parameters, and response formats.
- Privileges Checking, querying, and setting user privileges.
- Partitions Entity organization and access control through partitions.
- Logging How to configure logging, diagnostics, and debug methods.
-
Plugin SDK
- Overview Introduction to plugin architecture and capabilities.
- Certificates SDK certificate requirements for plugin roles.
- Lifecycle Initialization and disposal patterns.
- Threading Threading model, QueueUpdate, and async patterns.
- State Management Reporting plugin health and diagnostics.
- Configuration Configuration storage and monitoring.
- Restricted Configuration Secure credential storage and admin-only configuration.
- Events Event subscription and handling.
- Queries Query processing and response handling.
- Request Manager Request/response communication with clients.
- Database Database integration and schema management.
- Entity Ownership Understanding plugin-owned entities, running state management, and ownership release.
- Entity Mappings Using EntityMappings for plugin-specific configuration and external system integration.
- Server Management High availability and server failover.
- Custom Privileges Defining and enforcing custom privileges.
- Custom Entity Types Defining and managing plugin-specific entity types.
- Resolving Non-SDK Assemblies Handling third-party dependencies in plugins and workspace modules.
- Deploying Plugins Registering and deploying plugins and workspace modules.
- .NET 8 Support Building plugins with .NET 8 and .NET Standard compatibility.
-
Workspace SDK
- Overview Introduction to client-side UI extensions for Security Desk and Config Tool.
- Certificates SDK certificate requirements for workspace modules.
- Creating Modules Module lifecycle, registration patterns, and assembly resolution.
- Tasks Executable actions, home page entries, and programmatic invocation.
- Pages Page content, lifecycle, descriptors, and navigation.
- Components Dashboard widgets, tiles, maps, credentials, and content builders.
- Tile Extensions Custom tile widgets, views, and properties panels.
- Services Built-in services for dialogs, maps, alarms, badges, and more.
- Contextual Actions Right-click context menu extensions.
- Options Extensions Custom settings pages in application preferences.
- Configuration Pages Entity configuration pages for Config Tool.
- Monitors Multi-monitor support and shared components.
- Shared Components Using monitor and workspace shared UI components.
- Commands Command execution, evaluation, and interception.
- Extending Events Adding custom fields to Security Center events.
- Map Extensions Custom map objects, layers, and providers.
- Timeline Providers Custom timeline event sources for video playback.
- Image Extractors Custom image sources for cardholder photos and custom fields.
- Credential Encoders Encoding credentials with custom encoder components.
- Cardholder Fields Extractors Importing cardholder data from external sources.
- Content Builders Building and customizing tile content in Security Desk.
-
Macro SDK
- Overview How macros work, creating and configuring macro entities, automation, and monitoring.
- Developer Guide Developing macro code with the UserMacro class and Security Center SDK.
-
- 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.
- Tasks Listing and executing saved report tasks.
- Macros Monitoring currently running macros.
- Custom Entity Types Listing, retrieving, and deleting custom entity type descriptors.
- System Endpoints License usage, web tokens, and exception handling.
- 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 Guide Setup and configuration of the Media Gateway role for video streaming.
- Developer Guide Complete guide to integrating GWP for live and playback video streaming.
- API Reference Full API documentation with interfaces, methods, properties, and events.
- Sample Application Comprehensive demo showcasing all GWP features with timeline and PTZ controls.
- Multiplexing Sample Multi-camera grid demo using a shared WebSocket connection.