Skip to content

web sdk reference

Andre Lafleur edited this page May 10, 2026 · 22 revisions

Web SDK reference

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. New entities are placed here unless a different creation partition is set for the session.
System Partition 00000000-0000-0000-0000-0000000000BB System partition containing core system entities

Cardholder groups

Entity GUID Description
All Cardholders 00000000-0000-0000-0000-000000000008 Built-in group containing all cardholders
Visitors 00000000-0000-0000-0000-00000000000D Built-in group used for visitors

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

Built-in card format identifiers

These GUIDs identify standard card formats built into Security Center. They are credential format identifiers that can appear in credential responses, for example GetCredentialFormatId(). They are not entity GUIDs, so /entity?q=entity={guid} cannot resolve them. When you create a built-in-format credential, use the credential Format= constructors documented in Access control instead of these GUIDs.

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

Privilege GUIDs

Privilege GUIDs are stable system-wide identifiers. Use these values with SetPrivilegeState and HasPrivilege on user and user group entities. For usage examples, see Users and user groups.

Application access

Privilege GUID
Run Config Tool 1b03c89e-0b02-4d68-b281-ef5a4f76146c
Run Security Desk 5c9348a7-faa7-4aa1-b8a9-d0761a7be118
Log on using the SDK 7ab29b46-f363-4cad-9e05-1bcb9b65d49c
Web client connection a21a5c23-d214-420d-a3d9-b146f2b4e589

Cardholders and credentials

Privilege GUID
View cardholders db9d9c99-f571-4202-b768-d5585b6e1614
Modify cardholders af0902fb-34ba-427a-b246-52b5643b3d4d
Add cardholders 2cb1308f-1e15-4a5d-897f-876004020366
Delete cardholders b50a0b91-eddd-4c60-8725-744c304210b5
View cardholder groups b4ce6ce5-a190-48e4-b5bc-0b37a0716133
Modify cardholder groups 7e6d62f7-abeb-4a41-b42e-1c7f2942c42e
Add cardholder groups 760a7174-939f-425a-aeb1-993597d746d7
Delete cardholder groups 28f168c1-e170-4f65-9e7d-b379aeeb9209
View credentials 7209fb2d-1943-4ce5-b8ec-24c22c68f60d
Modify credentials 6cc7d53b-3087-47a7-af91-5db1cbfcd812
Add credentials 38de2e34-3746-4922-9e10-db87407393da
Delete credentials 3dc50349-a0aa-41dc-8bee-6eb2645fb5b8

Access control

Privilege GUID
View access rules dcf2d1d1-5c2a-4fec-abb2-2b0a16c9b165
Modify access rules 30b467a6-696a-4753-bfee-078561c1e2ff
Add access rules c05f27d3-708e-412d-a2c3-e95374860227
Delete access rules b2609562-e0fb-4cd2-9f96-909f42f141d6
View doors c546db4d-ef5e-4ad1-a727-7690a19af891
Modify doors 7d5fbfa3-5b0d-4e1d-b80c-6ef089902793
Unlock door 6c5daa2a-f973-4f02-91bd-629e01423d00
View areas 6095e91e-25bb-430d-a9db-16fe6af51bdc
Modify areas d4586106-f2fb-4b29-8f03-4efeafc36e5f
View access control units 061254aa-420f-4b93-834a-a5fe78ccb803
Add access control units 81658baa-eb21-4eb8-b8ff-0703fb636053
Delete access control units d80b69a6-22e3-44bb-84da-483184075330

Video

Privilege GUID
View cameras 7902233c-5e84-4de1-ae6e-7803ddf42384
Modify cameras 529a30e2-802c-4a6f-9a89-f1eacccd8bfb
Add cameras 35914b9d-215c-4d60-bda1-69eb2f8c3ee7
Remove cameras f877f653-4a5a-481b-b19c-3a474b570d93
Export video 5fcb1e19-d873-4b4d-939b-7cb4c301edd6

Alarms

Privilege GUID
View alarms 0cfe2198-ce16-48af-8f0b-fc029330e8e0
Modify alarms b0f6025f-a29a-43c7-bfc8-6c6f77a2b70a
Add alarms 068c4d28-fa2c-4900-a815-a0d5e7cec431
Delete alarms a1bfe350-3a63-41dc-84d5-e4b0e1954852
Acknowledge alarms 44a227bb-7bda-4719-9969-7703f0056241

Incidents

Privilege GUID
Report incidents 416b7e52-9bf5-470e-8cad-c633e4e7b0ad
Modify reported incidents 7ef737f9-44e3-47bc-a54a-8fa0121cefca
Modify incident categories 8077aa4b-2085-48b6-9aec-b3b88288ef7a

Macros

Privilege GUID
Execute macros ca2a41e8-1d56-4172-95a8-261fb897c988

Schedules

Privilege GUID
View schedules 2c144bd7-62c4-4b34-86e4-94065d9ab2c6
Modify schedules f58e60a8-96ab-461e-86c3-81fac184d186
Add schedules 55744566-9300-4290-adde-27f7cdf79b73
Delete schedules 6958b88f-a415-4584-b372-79effd8360a8

Users and user groups

Privilege GUID
View user properties 87f5ed6b-b67a-4a19-acab-d20c1962fd02
Delete user b47c8146-b2f6-4f68-a20a-d7f22ee382d7
View user group properties 024d7ab4-f392-4e40-b50f-aa8672188728
Create user group 610720d7-6d97-4ddf-8014-5779030e375d
Delete user group d41261d2-49b5-479b-9c5b-5d1c17cb4a0b

Maps

Privilege GUID
View maps f645d890-21a4-4bb8-82ff-1c58e2cd4a94

Enumerations

Note

Use these names exactly as shown when constructing requests and parsing responses. Some contain unconventional spellings that must be preserved.

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
None 0 No No Not specified
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
ReportTemplate 26 No No Legacy report template entity (obsolete)
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

EventType enumeration

System event types in Security Center. Use these IDs when subscribing to events or filtering event streams. To raise a custom event, use the custom event ID with /events/RaiseCustomEvent (see Monitoring events and alarms).

The Can Raise column indicates whether the event type can be raised through the Web SDK /events/RaiseEvent endpoint. Use a source entity whose SupportedEvents includes the event type. For details, see Raise a system event.

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
CardholderWalkthrough 12 No Cardholder Walkthrough
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
DoorForcedOpen 29 No Obsolete. Use DoorOpenWhileLockSecure
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
IntrusionAreaMasterArmRequest 525 No Intrusion area master arm request event
IntrusionAreaPerimeterArmRequest 526 No Intrusion area perimeter arm request event
IntrusionAreaDisarmRequest 527 No Intrusion area disarm request event
IntrusionAreaArmingPostponedRequest 528 No Intrusion area arming postponed request event
IntrusionAreaCanceledAlarmRequest 529 No Intrusion area canceled alarm request event
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
ZoneWarningUnitOnline 773 No The master unit controlling the zone is offline event
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)
CameraOldBwcRecordingUploaded 1404 No SCU uploaded old recordings to BwcManager
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
HealthMonitoringEventUnVideoSignalRecovered 1804 No Health monitoring event VideoSignalRecovered
HealthMonitoringEventApplicationStarted 1805 No Health monitoring event ApplicationStarted
HealthMonitoringEventApplicationStoppedByUser 1806 No Health monitoring event ApplicationStoppedByUser
HealthMonitoringEventApplicationStoppedUnexpectedly 1807 No Health monitoring event ApplicationStoppedUnexpectedly
HealthMonitoringEventArchiveBackupFailure 1808 No Health monitoring event ArchiveBackupFailure
HealthMonitoringEventArchiveBackupSuccess 1809 No Health monitoring event ArchiveBackupSuccess
HealthMonitoringEventArchiveConsolidationFailure 1810 No Health monitoring event ArchiveConsolidationFailure
HealthMonitoringEvenArchiveConsolidationPartialFailuret 1811 No Health monitoring event ArchiveConsolidationPartialFailure
HealthMonitoringEventArchiveConsolidationSuccess 1812 No Health monitoring event ArchiveConsolidationSuccess
HealthMonitoringEventArchiverTricklingFailure 1813 No Health monitoring event ArchiverTricklingFailure
HealthMonitoringEventArchiverTricklingPartialFailure 1814 No Health monitoring event ArchiverTricklingPartialFailure
HealthMonitoringEventArchiverTricklingSuccess 1815 No Health monitoring event ArchiverTricklingSuccess
HealthMonitoringEventCameraConnectionEstablished 1816 No Health monitoring event CameraConnectionEstablished
HealthMonitoringEventCameraConnectionStoppedByUser 1817 No Health monitoring event CameraConnectionStoppedByUser
HealthMonitoringEventCameraConnectionStoppedUnexpectedly 1818 No Health monitoring event CameraConnectionStoppedUnexpectedly
HealthMonitoringEventCameraRecordingProblem 1819 No Health monitoring event CameraRecordingProblem
HealthMonitoringEventCameraRecordingProblemRecovered 1820 No Health monitoring event CameraRecordingProblemRecovered
HealthMonitoringEventUnitTimeDrift 1821 No Health monitoring event UnitTimeDrift
HealthMonitoringEventUnitTimeDriftRecovered 1822 No Health monitoring event UnitTimeDriftRecovered
HealthMonitoringEventConnectionFailed 1823 No Health monitoring event ConnectionFailed
HealthMonitoringEventConnectionRestored 1824 No Health monitoring event ConnectionRestored
HealthMonitoringEventDatabaseAutomaticBackupFailed 1825 No Health monitoring event DatabaseAutomaticBackupFailed
HealthMonitoringEventDatabaseAutomaticBackupRecovered 1826 No Health monitoring event DatabaseAutomaticBackupRecovered
HealthMonitoringEventDatabaseFailoverMasterLost 1827 No Health monitoring event DatabaseFailoverMasterLost
HealthMonitoringEventDatabaseFailoverMasterRecovered 1828 No Health monitoring event DatabaseFailoverMasterRecovered
HealthMonitoringEventDatabaseLost 1829 No Health monitoring event DatabaseLost
HealthMonitoringEventDatabaseRecovered 1830 No Health monitoring event DatabaseRecovered
HealthMonitoringEventDatabaseRestoreFailure 1831 No Health monitoring event DatabaseRestoreFailure
HealthMonitoringEventDatabaseRestoreSuccess 1832 No Health monitoring event DatabaseRestoreSuccess
HealthMonitoringEventDirectoryStarted 1833 No Health monitoring event DirectoryStarted
HealthMonitoringEventDirectoryStoppedByUser 1834 No Health monitoring event DirectoryStoppedByUser
HealthMonitoringEventDirectoryStoppedUnexpectedly 1835 No Health monitoring event DirectoryStoppedUnexpectedly
HealthMonitoringEventHighCPUUsage 1836 No Health monitoring event HighCPUUsage
HealthMonitoringEventHighCPUUsageRecovered 1837 No Health monitoring event HighCPUUsageRecovered
HealthMonitoringEventHighMemoryUsage 1838 No Health monitoring event HighMemoryUsage
HealthMonitoringEventHighMemoryUsageRecovered 1839 No Health monitoring event HighMemoryUsageRecovered
HealthMonitoringEventLiveHealthMonitoringRecovered 1840 No Health monitoring event LiveHealthMonitoringRecovered
HealthMonitoringEventLiveHealthMonitoringStopped 1841 No Health monitoring event LiveHealthMonitoringStopped
HealthMonitoringEventLowArchiveSpace 1842 No Health monitoring event LowArchiveSpace
HealthMonitoringEventLowArchiveSpaceRecovered 1843 No Health monitoring event LowArchiveSpaceRecovered
HealthMonitoringEventLowDatabaseSpace 1844 No Health monitoring event LowDatabaseSpace
HealthMonitoringEventLowDatabaseSpaceRecovered 1845 No Health monitoring event LowDatabaseSpaceRecovered
HealthMonitoringEventOffloadFailed 1846 No Health monitoring event OffloadFailed
HealthMonitoringEventSynchronizationRecovered 1847 No Health monitoring event SynchronizationRecovered
HealthMonitoringEventOffloadRecovered 1848 No Health monitoring event OffloadRecovered
HealthMonitoringEventPatrollerOffline 1849 No Health monitoring event PatrollerOffline
HealthMonitoringEventPatrollerOnline 1850 No Health monitoring event PatrollerOnline
HealthMonitoringEventPOSDatabaseLost 1851 No Health monitoring event POSDatabaseLost
HealthMonitoringEventPOSDatabaseRecovered 1852 No Health monitoring event POSDatabaseRecovered
HealthMonitoringEventRoleStarted 1853 No Health monitoring event RoleStarted
HealthMonitoringEventRoleStoppedByUser 1854 No Health monitoring event RoleStoppedByUser
HealthMonitoringEventRoleStoppedUnexpectedly 1855 No Health monitoring event RoleStoppedUnexpectedly
HealthMonitoringEventRTPPacketLoss 1856 No Health monitoring event RTPPacketLoss
HealthMonitoringEventRTPPacketLossRecovered 1857 No Health monitoring event RTPPacketLossRecovered
HealthMonitoringEventServiceStarted 1858 No Health monitoring event ServiceStarted
HealthMonitoringEventServiceStoppedByUser 1859 No Health monitoring event ServiceStoppedByUser
HealthMonitoringEventServiceStoppedUnexpectedly 1860 No Health monitoring event ServiceStoppedUnexpectedly
HealthMonitoringEventSynchronizationFailed 1861 No Health monitoring event SynchronizationFailed
HealthMonitoringEventTransmissionLost 1862 No Health monitoring event TransmissionLost
HealthMonitoringEventTransmissionRecovered 1863 No Health monitoring event TransmissionRecovered
HealthMonitoringEventUnauthorizedDisk 1864 No Health monitoring event UnauthorizedDisk
HealthMonitoringEventUnauthorizedDiskRecovered 1865 No Health monitoring event UnauthorizedDiskRecovered
HealthMonitoringEventUnitConnectionFailed 1866 No Health monitoring event UnitConnectionFailed
HealthMonitoringEventUnitConnectionRestored 1867 No Health monitoring event UnitConnectionRestored
HealthMonitoringEventUnitConnectionStopped 1868 No Health monitoring event UnitConnectionStopped
HealthMonitoringEventUnitTricklingFailure 1869 No Health monitoring event UnitTricklingFailure
HealthMonitoringEventUnitTricklingPartialFailure 1870 No Health monitoring event UnitTricklingPartialFailure
HealthMonitoringEventUnitTricklingSuccess 1871 No Health monitoring event UnitTricklingSuccess
HealthMonitoringEventEdgeStorageRecovered 1872 No Health monitoring event EdgeStorageRecovered
HealthMonitoringEventEdgeStorageFailure 1873 No Health monitoring event EdgeStorageFailure
HealthMonitoringEventEdgeStorageRecordingRecovered 1874 No Health monitoring event EdgeStorageRecordingRecovered
HealthMonitoringEventEdgeStorageRecordingFailure 1875 No Health monitoring event EdgeStorageRecordingFailure
HealthMonitoringEventArchiverTricklingRetry 1876 No Health monitoring event ArchiverTricklingRetry
HealthMonitoringEventArchiverTricklingCancel 1877 No Health monitoring event ArchiverTricklingCancel
HealthMonitoringEventCertificateValid 1878 No Health monitoring event CertificateValid
HealthMonitoringEventCertificateWarning 1879 No Health monitoring event CertificateWarning
HealthMonitoringEventCertificateError 1880 No Health monitoring event CertificateError
HealthMonitoringEventValidDriverPack 1881 No Health monitoring event ValidDriverPack
HealthMonitoringEventInvalidDriverPack 1882 No Health monitoring event InvalidDriverPack
HealthMonitoringEventArchivingNotMonitored 1883 No Health monitoring Event ArchivingNotMonitored
HealthMonitoringEventApplicationConnectionNotMonitored 1884 No Health monitoring Event ApplicationConnectionNotMonitored
HealthMonitoringEventApplicationNotMonitored 1885 No Health monitoring Event ApplicationNotMonitored
HealthMonitoringEventConnectionNotMonitored 1886 No Health monitoring Event ConnectionNotMonitored
HealthMonitoringEventUnitConnectionNotMonitored 1887 No Health monitoring event UnitConnectionNotMonitored
HealthMonitoringEventDatabaseAutomaticBackupNotMonitored 1888 No Health monitoring Event DatabaseAutomaticBackupNotMonitored
HealthMonitoringEventDatabaseNotMonitored 1889 No Health monitoring event DatabaseNotMonitored
HealthMonitoringEventHighCPUUsageNotMonitored 1890 No Health monitoring Event HighCPUUsageNotMonitored
HealthMonitoringEventHighMemoryUsageNotMonitored 1891 No Health monitoring Event HighMemoryUsageNotMonitored
HealthMonitoringEventLowDatabaseSpaceNotMonitored 1892 No Health monitoring Event LowDatabaseSpaceNotMonitored
HealthMonitoringEventOffloadNotMonitored 1893 No Health monitoring Event OffloadNotMonitored
HealthMonitoringEventPatrollerNotMonitored 1894 No Health monitoring Event PatrollerNotMonitored
HealthMonitoringEventPOSDatabaseNotMonitored 1895 No Health monitoring Event POSDatabaseNotMonitored
HealthMonitoringEventRoleNotMonitored 1896 No Health monitoring Event RoleNotMonitored
HealthMonitoringEventRTPPacketNotMonitored 1897 No Health monitoring Event RTPPacketNotMonitored
HealthMonitoringEventServiceNotMonitored 1898 No Health monitoring Event ServiceNotMonitored
HealthMonitoringEventSynchronizationNotMonitored 1899 No Health monitoring Event SynchronizationNotMonitored
HealthMonitoringEventVideoSignalNotMonitored 1900 No Health monitoring Event VideoSignalNotMonitored
HealthMonitoringEventUnauthorizedDiskNotMonitored 1901 No Health monitoring Event UnauthorizedDiskNotMonitored
HealthMonitoringEventActiveAlarmsNotMonitored 1902 No Health monitoring Event ActiveAlarmsNotMonitored
HealthMonitoringEventDirectoryNotMonitored 1903 No Health monitoring Event DirectoryNotMonitored
HealthMonitoringEventLowArchiveSpaceNotMonitored 1904 No Health monitoring Event LowArchiveSpaceNotMonitored
HealthMonitoringEventLiveHealthMonitoringNotMonitored 1905 No Health monitoring Event LiveHealthMonitoringNotMonitored
HealthMonitoringEventDatabaseFailoverMasterNotMonitored 1906 No Health monitoring Event DatabaseFailoverNotMonitored
HealthMonitoringEventDatabaseRestoreNotMonitored 1907 No Health monitoring Event DatabaseRestoreNotMonitored
HealthMonitoringEventUnitTricklingNotMonitored 1908 No Health monitoring Event UnitTricklingNotMonitored
HealthMonitoringEventArchiveBackupNotMonitored 1909 No Health monitoring Event ArchiveBackupNotMonitored
HealthMonitoringEventAgentNotMonitored 1910 No Health monitoring Event AgentNotMonitored
HealthMonitoringEventArchiveConsolidationNotMonitored 1911 No Health monitoring Event ArchiveConsolidationNotMonitored
HealthMonitoringEventCameraRecordingNotMonitored 1912 No Health monitoring Event CameraRecordingNotMonitored
HealthMonitoringEventCameraConnectionNotMonitored 1913 No Health monitoring Event CameraConnectionNotMonitored
HealthMonitoringEventUnitTimeDriftNotMonitored 1914 No Health monitoring Event UnitTimeDriftNotMonitored
HealthMonitoringEventTransmissionNotMonitored 1915 No Health monitoring Event TransmissionNotMonitored
HealthMonitoringEventEdgeStorageNotMonitored 1916 No Health monitoring Event EdgeStorageNotMonitored
HealthMonitoringEventEdgeStorageRecordingNotMonitored 1917 No Health monitoring Event EdgeStorageRecordingNotMonitored
HealthMonitoringEventArchiverTricklingNotMonitored 1918 No Health monitoring Event ArchiverTricklingNotMonitored
HealthMonitoringEventCertificateNotMonitored 1919 No Health monitoring Event CertificateNotMonitored
HealthMonitoringEventDriverPackNotMonitored 1920 No Health monitoring Event DriverPacksNotMonitored
HealthMonitoringEventScTokenValid 1921 No Health monitoring event SC Token Valid
HealthMonitoringEventScTokenError 1922 No Health monitoring event SC Token Error
HealthMonitoringEventScTokenNotMonitored 1923 No Health monitoring event SC Token Not Monitored
HealthMonitoringEventEntityOnline 1924 No Health monitoring event Entity online
HealthMonitoringEventEntityOffline 1925 No Health monitoring event Entity offline
HealthMonitoringEventEntityNotMonitored 1926 No Health monitoring event Entity Not Monitored
HealthMonitoringEventOptimizedDirectoryStartupSucceeded 1927 No Health monitoring event Optimized Directory Startup Succeeded
HealthMonitoringEventOptimizedDirectoryStartupFailed 1928 No Health monitoring event Optimized Directory Startup Failed
HealthMonitoringEventOptimizedDirectoryStartupNotMonitored 1929 No Health monitoring event Optimized Directory Startup Not Monitored
HealthMonitoringArchivedEntityCleanupForAlarmsResumedEvent 1930 No Retention grace period started successfully health event type
HealthMonitoringEventArchivedEntityCleanupForAlarmsPaused 1931 No Retention grace period failed to start health event type
HealthMonitoringArchivedEntityCleanupForIncidentsResumedEvent 1932 No Retention grace period not monitored health event type
HealthMonitoringEventArchivedEntityCleanupForIncidentsPaused 1933 No Retention grace period not monitored health event type
HealthMonitoringArchivedEntityCleanupForAuditsResumedEvent 1934 No Retention grace period not monitored health event type
HealthMonitoringEventVideoStorageMightRunOutIsInactive 1935 No Warning that files might get deleted because of storage is cleared
HealthMonitoringEventVideoStorageMightRunOutIsActive 1936 No Warning that files might get deleted because of storage is active
HealthMonitoringEventArchivedEntityCleanupForAuditsPaused 1937 No Retention grace period not monitored health event type
HealthMonitoringEventCloudStorageDeactivatedDueToLicenseChangeRecovered 1938 No Warning that files might get deleted because of storage is cleared
HealthMonitoringEventCloudStorageDeactivatedDueToLicenseChange 1939 No Warning that files might get deleted because of storage is active
AreaAntipassbackDisabledMixedMode 2048 No Antipassback disabled: Not supported when unit is in mixed mode
AreaAntipassbackDisabledUnitOffline 2049 No Antipassback disabled: Unit is offline
AreaPeopleCountDisabledUnitOffline 2050 No People counting disabled: Unit is offline
AreaAntipassbackDisabledPerimeterOnElevator 2051 No Antipassback disabled: Elevator on area perimeter
AreaSasOverrideOn 2052 No Interlock override on
AreaSasOverrideOff 2053 No Interlock override off
AreaSasLockdownOn 2054 No Interlock lockdown on
AreaSasLockdownOff 2055 No Interlock lockdown off
AreaSasMultipleUnitWarning 2056 No Multiple units are configured for the interlock
AreaSasUnsupportedWarning 2057 No Interlock is not supported by the unit
AreaSasMaintenanceModeWarning 2058 No A door of an interlock is in maintenance mode
AreaSasFreeAccessWarning 2059 Yes A door of an interlock has an unlock schedule configured
AreaSasAntipassbackWarning 2060 No An interlock cannot be in hard antipassback mode
AreaSasFloorWarning 2061 No An interlock cannot have perimeter floors
AreaAntipassbackDisabledInvalidSettings 2062 No Antipassback disabled: Invalid settings
AreaSasOnePerimeterDoorWarning 2063 No An interlock cannot have only one perimeter door
AreaSasDoorWithNoSensorWarning 2064 No An interlock cannot have a perimeter door with no sensor configured
AreaLast 2303 No Area Last
ElevatorWarningUnitOffline 2304 No Elevator warning : unit is offline
ElevatorSecuredOnSchedule 2305 No Elevatur scheduled for secured access
ElevatorFreeAccessOnSchedule 2306 No Elevator scheduled for free access
AlarmInvestigating 2384 No Event when an Alarm is being investigated
AlarmForciblyAcked 2385 No Event when an Alarm is acknowledged forcibly
ThreatLevelActivated 2416 No Event when a threat level is activated on an area
ThreatLevelDeactivated 2417 No Event when a threat level is deactivated on an area
CardholderNoEntryDetected 2432 No Cardholder no entry detected event
DoorNoEntryDetected 2448 No Door no entry detected event
CardholderNoEntryDetectedAccessGrantedNoEntry 2449 No Event Cardholder with no entry detected has access granted No entry
CardholderEntryDetected 2464 No Cardholder entry detected event
CardholderEntryAssumed 2465 No Cardholder entry assumed event
VisitorAstray 2466 Yes VisitorAstray event
MissingTailEscort 2467 Yes Missing tail escort event
DoorEntryDetected 2480 Yes Door entry detected event
DoorEntryDetectedAccessGrantedNoEntry 2481 No Door entry detected with access granted no entry event
DoorEntryGrantedDespiteAPBViolation 2482 No Door entry granted despite APB violation
DoorEntryAssumed 2496 No Door entry assumed event
OfflineSynchronizationStarted 2512 No Offline unit synchronization started event
OfflineSynchronizationFailure 2513 No Offline unit synchronization failed event
OfflineSynchronizationSuccess 2514 No Offline unit synchronization succeeded event
UnitFirmwareUpgradeStarted 2515 No Unit firmware upgrade started event
UnitFirmwareUpgradeSuccess 2516 No Unit firmware upgrade success event
UnitFirmwareUpgradeFailure 2517 No Unit firmware upgrade failure event
UnitFirmwareUpgradeScheduled 2518 No Unit firmware upgrade scheduled event
UnitFirmwareUpgradeCancelled 2519 No Unit firmware upgrade cancelled event
InterfaceFirmwareUpgradeStarted 2520 No Interface module firmware upgrade started event
InterfaceFirmwareUpgradeSuccess 2521 No Interface module firmware upgrade success event
InterfaceFirmwareUpgradeFailure 2522 No Interface module firmware upgrade failure event
InterfaceFirmwareUpgradeScheduled 2523 No Interface module firmware upgrade scheduled event
InterfaceFirmwareUpgradeCancelled 2524 No Interface module firmware upgrade cancelled event
InterfaceFirmwareUpgradeTransferred 2525 No Interface module firmware upgrade transferred event
DeniedByAutomationEngine 2527 Yes Access denied by Synergis Softwire Automation Engine
GrantConfirmationTimeout 2528 No Access denied with valid card but timeout events
PassageCountExceeded 2529 No Access denied because of passage count exceeded
SinglePersonCheckFailed 2530 No Single person check failed
SinglePersonCheckFailedNoPresenceDetected 2531 Yes Single person check failed because no presence was detected
SinglePersonCheckFailedTooManyPeople 2532 Yes Single person check failed because too many people were detected
AccessInvalidPin 2544 Yes Access denied Invalid PIN Event
AccessValidCardInvalidPin 2545 Yes Access denied with valid card but invalid PIN Event
AccessDeniedByAccessRule 2546 Yes Access denied by access rule event
AccessInsufficientPrivileges 2547 Yes Access denied insufficient privileges event
AccessAntipassbackViolation 2548 Yes Acess denied antipassback violation event
AccessOutOfSchedule 2549 Yes Access denied with out of schedule event
AccessNoAccessRuleAssigned 2550 Yes Access denied with no access rule assigned event
AccessAbsentSupervisor 2551 Yes Access denied because no supervisor was defined and the first in rule is enabled
AccessEscortRequired 2552 Yes Access denied with escort required event
AccessSecondCardholderRequired 2553 Yes Access denied with second cardholder required event
AccessEscortNotSupported 2554 Yes Access denied because the escort is not supported by the unit
CompanionVisitorDenied 2555 No Access denied because a companion visitor was denied access
Interlock 2556 No Access denied because interlock event
AccessCardAndPINTimeout 2557 Yes Access denied because access card and pin timed out
AccessValidCardInactivePIN 2558 Yes Access denied with valid card but inactive pin event
AccessDeniedByMaxOccupancy 2559 Yes Access denied because max occupancy reached
IntrusionUnitInputTrouble 2560 No The intrusion detection unit input trouble
IntrusionUnitInputBypassActivated 2561 No The intrusion detection unit input bypass activated
IntrusionUnitInputBypassDeactivated 2562 No The intrusion detection unit input bypass deactivated
IntrusionUnitTamper 2563 No The intrusion detection unit tamper
InputStateActive 2816 No Event when an Input state changed to active
InputStateNormal 2817 No Event when an Input state changed to normal
InputStateTrouble 2818 No Event when an Input state changed to trouble
InputAlarmActive 2819 No Event when an Input arming state changed to active
InputAlarmRestored 2820 No Event when an Input arming state changed to armed
InputBypassed 2821 No Event when an Input arming state changed to bypass
InputBypassRestored 2822 No Event when an Input arming state restored from bypass
InputShunted 2823 No Event when an Input is shunted
InputUnshunted 2824 No Event when an Input is unshunted
ArchiverDiskFull 3072 No Event that indicates the Archiver Disk is full
ArchiverFileProtectionSuccess 3073 Yes Event that indicates the file protection for multiple cameras has been applied successfully
ArchiverFileProtectionFailure 3074 Yes Event that indicates the file protection for multiple cameras has failed to be applied
ArchiverCanWrite 3075 No Event that indicates that the archiver is ready to write
ArchiverDatabaseLost 3076 No Event that indicates that the archiver database connection was lost
ArchiverDatabaseRecovered 3077 No Event that indicates that the archiver database connection was recovered
ArchiverDiskChanged 3078 No Event that indicates that the archiver disk has changed
ArchiverDiskLoad 3079 No Event that indicates that the archiver database disk is busy
ArchiverInvalidCustomEncryption 3080 No Event that indicates that the archiver custom encryption is invalid
ArchiverNoWrite 3081 No Event that indicates that the archiver cannnot write
ArchiverNoWriteOnSpecifiedDisk 3082 No Event that indicates that the archiver is now writing on a specified Disk
ArchiverArchivingStopped 3083 No Event that indicates that the archiver has stopped archiving
ArchiverBackupStarted 3084 No Event that indicates that the archiver backup has started
ArchiverBackupSucceeded 3085 No Event that indicates that the archiver Backup has succeeded
ArchiverBackupFailed 3087 No Event that indicates that the archiver Backup has failed
ArchiverProtectionThresholdExceeded 3088 No Event that indicates that the archiver protection has exceeded the threshold
ArchiverVrmConnectionAttempt 3089 No Event that indicates a vrm connection attempt to the archiver vrm
ArchiverVrmConnectionFailure 3090 No Event that indicates a vrm connection to the archiver vrm has failed
ArchiverPathTooLong 3091 No Event that indicates a archiver path is too long
ArchiverDatabaseFlooding 3092 Yes Event that indicates the Archiver floods the database
ArchiverLostConnectionWithCloudStorage 3093 No A device stopped live streaming
ArchiverReconnectedToCloudStorage 3094 No A device stopped live streaming
ArchiverFilesWillBeDeletedDiskFull 3095 No Event that indicates that files will be deleted because Archiver disk will be full before retention starts
ParkingSessionStartedByVehicleEntered 3328 No Event when session created due to a new vehicle entering the parking zone
ParkingSessionStartedByUnknownVehicleExited 3329 No Event when session created due to an unknown vehicle exiting
ParkingSessionConvenienceTimeStarted 3330 No Event when session convenience time begins
ParkingSessionValidatingPaidTimeByConvenienceTimeExpired 3331 No Event when paid time validation begins after convenience time expired
ParkingSessionValidatingPaidTimeByPaidTimeExpired 3332 No Event when paid time validation begins after paid time expired
ParkingsessionPaidTimeStartedByPaidTimeValid 3333 No Event when paid time begins after paid time originally valid
ParkingSessionPaidTimeStartedByValidationError 3334 No Event when paid time begins after paid time invalid
ParkingSessionGracePeriodStartedByConvenienceTimeExpired 3335 No Event when grace period begins due to convenience time expiring
ParkingSessionGracePeriodStartedByPaidTimeInvalid 3336 No Event when grace period started due to paid time becoming invalid
ParkingSessionViolationDetectedByConvenienceTimeExpired 3337 No Event when violation detected because of convenience time expiring
ParkingSessionViolationDetectedByGracePeriodExpired 3338 No Event for violation detected from when grace period expired
ParkingSessionViolationDetectedByPaidTimeInvalid 3340 No Event for violation detected due to paid time expiring
ParkingSessionViolationEnforced 3341 No Event for when a violation is enforced in the parking zone
ParkingSessionCompletedByInventoryReset 3342 No Event for when the parking session completes due to an inventory reset
ParkingSessionCompletedByMaxSessionTimeExceeded 3343 No Event for when the parking session completes due to the maximum session time for the session being reached
ParkingSessionCompletedByVehicledExited 3344 No Event for when the parking session completes due to the vehicle being associated with the session leaving the parking zone
ParkingSessionCompletedByVehicleReentered 3345 No Event for when the parking session completes due to the vehicle being detected as re-entering when not corresponding exit was detected
ParkingSessionCompletedByUnknownVehicleExited 3346 No Event for when the parking session completes due to an unknown vehicle exiting the parking zone (a vehicle that has no corresponding entrance read)
ParkingZoneInventoryReset 3347 No Event for when an inventory reset occurs on the parking zone
ParkingZoneCapacityThresholdReached 3348 No Event for when the configured capacity threshold of a parking zone is reached
ParkingSessionStarted 3349 No Event for when a parking session has started
ParkingSessionGracePeriodStarted 3350 No Event for when a parking grace session perdiod has started
ParkingSessionValidatingPaidTime 3351 No Event for when the parking session is validating the paid time
ParkingSessionPaidTimeStarted 3352 No Event for when parking session paid time has started
ParkingSessionViolationDetected 3353 No Event for when a violation is detected in the parking session
ParkingSessionCompleted 3354 No Event for when a parking session is completed
DoorWarningInterfaceBatteryFail 3355 No Event for when a door warning occur when a battery fail
DoorWarninInterfaceAcFail 3356 No Event for when a door warning occur when the AC fail
DoorWarningInterfaceTamperRestored 3357 No Event for when a warning for door tampering is restored
DoorWarningInterfaceBatteryFailRestored 3358 No Event for when a warning for a battery fail is restored
DoorWarningInterfaceAcFailRestored 3359 No Event for when a warning for a AC fail is restored
ParkingSessionNoZoneRuleAssigned 3360 No Event for when it is impossible to assigned a parking zone for the plate number for a parking session
ParkingSessioReadEdited 3361 No Event for when a parking session state transition due to an edited read
ParkingSessionRuleDeleted 3362 No Event for when a parking session state transitions due to the deletion of the parking rule
ParkingSessionSharedPermitMatch 3363 No Event for when a a vehicle sharing a permit id enters a parking zone and at the same time the other vehicle with the same permit id is also parked
ParkingSessionCompletedByRuleDeleted 3364 No Event for when the parking session completes due to rule deleted
ParkingSessionCompletedManually 3365 No Event raised when the parking session is completed Manually
AudioAnalyticsCustom 3584 Yes Audio Analytics Custom event
DoorScheduledUnlockIgnored 3617 Yes Event for ignoring a door scheduled unlock
DoorWarningInterfaceTamper 3618 No Event for a tempering warning of a door interface
CardholderCredentialRequested 3619 No Event for a when a cardholder request a credential
CardholderCredentialRequestComplete 3620 No Event for a when a cardholder request for credential complete
CardholderCredentialRequestCancelled 3621 No Event for a when a cardholder request for credential is cancelled
CardholderAccessPointAccessGrantConfirmationRequested 3622 Yes Cardholder identity validation requested
CardholderIdentityValidationSucceeded 3623 No Cardholder identity validation succeeded
CardholderIdentityValidationSucceededBiometric 3624 Yes Cardholder identity validation succeeded: Biometric match
CardholderIdentityValidationSucceededManual 3625 Yes Cardholder identity validation succeeded: Operator confirmation
CardholderIdentityValidationFailed 3626 No Cardholder identity validation failed
CardholderIdentityValidationFailedBiometricMismatch 3627 Yes Cardholder identity validation failed: Biometric mismatch
CardholderIdentityValidationFailedBiometricMissing 3628 Yes Cardholder identity validation failed: Biometric profile missing
CardholderIdentityValidationFailedManual 3629 Yes Cardholder identity validation failed: Operator confirmation
CardholderIdentityValidationFailedTimeout 3630 Yes Cardholder identity validation failed: Timeout
CardholderSinglePersonCheckFailed 3631 No Cardholder single person check failed
CardholderSinglePersonCheckFailedNoPresenceDetected 3632 Yes Cardholder single person check failed because no presence was detected
CardholderSinglePersonCheckFailedTooManyPeople 3633 Yes Cardholder single person check failed because too many people were detected
CredentialHasExpired 3664 Yes Event for a when a credential has expired
CredentialIsExpiring 3665 Yes Event for a when a credential is expiring
LprUpdateInstalled 3666 No Event for a when a Lpr update is installed
LprUpdateUninstalled 3667 No Event for a when a Lpr update is uninstalled
LprUpdatePublished 3668 No Event for a when a Lpr update is published
LprUpdateError 3669 No Event for a when a Lpr update has an error
LprUpdateInstalling 3670 No Event for a when a Lpr update is installing
LprUpdateUninstalling 3671 No Event for a when a Lpr update is uninstalling
LprUpdatePackage 3672 No Event for a when a Lpr Update a package
ExternalSystemAlarmTriggered 3712 Yes Event for an alarm triggered from an external system
ExternalSystemSynchronizationStarted 3713 Yes Event for a system synchronisation that has started from an external system
ExternalSystemSynchronizationCompleted 3714 Yes Event for a system synchronisation that has completed from an external system
ExternalSystemSynchronizationError 3715 Yes Event for a system synchronisation has an error from an external system
ExternalSystemSynchronizationpartiallyCompleted 3716 Yes Event for a system synchronisation that has partially completed from an external system
AutoActionExecute 3717 No Event an auto action
EntityWarning 3718 No Event entity warning
UserModifiedincident 3719 No Event for when a user modified an incident
UserLoginFailed 3720 Yes Event when a user failed to login
unitInvalidConfig 3721 No Event when a unit has an invalid config
UnitTemperatureAlarm 3722 No Event when a unit trigger a temperature alarm
ServerLost 3723 No Event when the server is lost
CameraRtpPacketLostRecovery 3724 Yes Event when a camera rtp lost packet was recovered
InvalidatePatrollerMlpiReadsResultEvent 3725 No Event when a patroller MLPI read result was evaluated
CardholderCredentialExpired 3744 Yes Event is a Cardholder Access Refused. The cardholder credential is expired
CardholderCredentialInactive 3745 Yes Event is a Cardholder Access Refused. The cardholder credential is inactive
CardholderCredentiallost 3746 Yes Event is a Cardholder Access Refused. The cardholder credential is lost
CardholderCredentialStolen 3747 Yes Event is a Cardholder Access Refused. The cardholder credential is stolen
CommunicationsInviteSent 10240 No Event is a contact is getting called
CommunicationsCallRinging 10242 No Event for a call ringing
CommunicationsCallDeclined 10243 No Event for a call declined
CommunicationsCallAnswered 10244 No Event for a call answered
CommunicationsCallRejected 10245 No Event for a call rejected
CommunicationsCallTimeout 10246 No Event for a call timed out
CommunicationsCallEnded 10247 No Event for a call ended
CommunicationsCallStarted 10248 No Event for a call started
CommunicationsContactRegistered 10305 No Event for a contact registering
CommunicationsContactUnregistered 10306 No Event for a contact unregistering
CommunicationsTrunkRegistered 10369 No Event for a trunk registering
CommunicationsTrunkUnregistered 10370 No Event for a trunk unregistering
FusionRecordUpdatedEvent 10497 Yes Event called when an event is triggered by a fusion record
RecordFusionAutomationRuleHitEvent 10498 Yes Event called when a automation rule triggers
AutomationTriggered 10561 No Automation triggered
AutomationResponseStarted 10562 No Automation response started
AutomationResponseAborted 10563 No Automation response aborted
AutomationResponseCompleted 10564 No Automation response completed
CameraAbnormalMotion 10752 Yes Event signals an abnormal motion event
CameraNominalMotion 10753 No Event signals nominal motion event, as opposed to abnormal motion event
SecretKeyEvent 12288 No Events coming from the secret manager
SSOAuthEvent 12289 No SSOAuthEvent to troubleshootSSO authentication
UnitReplacementEvent 12290 No Event sent after a successful unit replacement
EventFilterConfigurationRecursiveUpdateEvent 12304 No Recursive Event Filter application update
Battery 12350 No Battery in lock
BatteryLow 12351 No Battery in lock is low
BatteryReplaced 12352 No Battery in lock was replaced successfully
LockUnsecured 12353 No Lock has failed to re-lock and is in a jammed mode
LocksetMessage 12354 No Lockset system message
DeviceRestarted 12355 No The lock electronics has restarted but is still operational
ConfigurationUpdated 12356 No Some configuration of the lock firmware has been performed. I
InternalError 12357 No Lock has detected an internal error
Undefined 12358 No Info missing
ProprietaryOfLockManufacturer 12359 No Can be used for lock manufacturer spe-cific codes
Blocklist 12360 No Blocklist in the lockset
BlocklistFull 12361 No Blocklist of credentials in the lockset
BlocklistedCredentialDetected 12362 No Lock has detected a blacklisted credential
BlocklistedCredential 12363 No Not possible to add more entries to the lock
ExpiredValidity 12364 No Denied access due to expired validity
OutsideSpecifiedSchedule 12365 No The current time did not match the specified DTSchedule
DefaultUnlockTime 12366 No Granted access with default unlock time
ExtendedUnlockTime 12367 No Granted access with extended unlock time
ToggleFunctionLocking 12368 No Granted access with toggle function locking
ToggleFunctionUnlocking 12369 No Granted access with toggle function unlocking
FailedToUnlock 12370 No Lock has failed to unlock door at some point
OfflineDoorUnsupported 12371 No Unsupported event from the lockset
RequestFileTransferConnection 12372 No Request for the federating system to create a file transfer connection

RoleType enumeration

Values for the Type property when creating a Role entity. Set Type in the same request as NewEntity(Role): a role cannot be created without a type, and the type cannot be changed after the role is created.

RoleType Value Description
None 0 Not specified
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

AccessRuleType enumeration

Value Description
Permanent Permanent access rule (default)
Temporary Temporary access rule

AlarmState enumeration

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

CardholderState enumeration

Value Description
Active Cardholder is active
Inactive Cardholder is inactive
Expired Cardholder is expired
Lost Cardholder is lost (obsolete)
Stolen Cardholder is stolen (obsolete)

CredentialState enumeration

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

CredentialType enumeration

Value Description
None Not specified
Keypad Input by keypad
UndecodedWiegand Undecoded Wiegand card
LicensePlate License plate recognition
CardRequest Card request

DeviceType enumeration

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

DoorType enumeration

Value Description
None Standard door
Mobile Mobile door
Offline Offline door

InputState enumeration

Value Description
Unknown State not known
Normal Normal state
Active Active state
TroubleShort Short trouble
TroubleOpen Open trouble
Unavailable Input unavailable
TroubleOff Trouble off

OutputState enumeration

Value Description
Unknown State not known
Normal Normal state
Active Active state

RecordingMode enumeration

Value Description
Off No archiving
Continuous Continuous archiving
OnMotionOrManual Archiving on motion detection or manual trigger
Manual Manual archiving only

RecordingState enumeration

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

State enumeration

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

UserStatus enumeration

Value Description
Activated User is activated
Deactivated User is deactivated

ZoneState enumeration

Value Description
Active Zone is active
Normal Zone is normal
Trouble Zone is troubled
Unknown Zone state is unknown

Built-in icon names

Use these names when a Security Center configuration accepts a built-in icon name, such as privilege XML image values. The names are case-insensitive, but use the casing shown here for consistency. This reference lists 100 commonly useful names for Web SDK, access control, video, reporting, and system administration scenarios.

If an icon name is not recognized, Security Center displays the generic Privilege icon.

Icon name Suggested use
AccessControl Access control features and entities
Action Generic actions
ActiveDirectory Active Directory integration
Add Create or add operations
Administration Administrative features
Alarm Alarm features
AlarmMonitoring Alarm monitoring tasks
Area Area entities
Asset Asset entities
Audio Audio features
AutomationManager Automation manager features
AutomationRule Automation rules
BackupSet Backup or restore sets
Badge Badge templates or badge workflows
Bookmark Video bookmarks
Building Building or site hierarchy
Camera Camera entities
CameraBlock Blocking camera video
CameraGroup Camera groups
CameraRecording Camera recording features
CameraUnblock Restoring blocked camera video
Cardholder Cardholder entities
CardholderGroup Cardholder groups
Copy Copy operations
Credential Credential entities
CriticalError Critical errors
CustomEntity Custom entity features
Dashboard Dashboard views
Database Database management
Door Door entities
DoorClosed Closed door state
Download Download operations
Edit Modify or edit operations
Elevator Elevator entities
Email Email notifications
EntityEventFilter Event filters for entities
EventsAndActions Events and actions
Export Export operations
Filter Filtered views or filtering operations
FirmwareUpgrade Firmware upgrade tasks
Flag Flagged items or marked states
GeneralOptions General options or settings
Health Health monitoring
History Historical data or audit views
Identity Identity-related features
Import Import operations
Incident Incident features
Information Informational messages
InputPin Input pins
Intrusion Intrusion features
IntrusionAlarm Intrusion alarms
IntrusionArea Intrusion areas
IntrusionUnit Intrusion units
Investigation Investigation tasks
Key Keys or authentication
License License management
Live Live monitoring
Lock Lock operations
Macro Macro features
Maintenance Maintenance tasks
Map Maps
MobileCredential Mobile credentials
Network Network features
OpenTask Opening or launching tasks
OutputPin Output pins
PartitionSystem System partition features
Playback Video playback
PluginOrange Plugin features
Privilege Generic privilege icon
Reader Access control readers
RecordingOff Recording disabled state
RecordingOn Recording enabled state
Refresh Refresh operations
Remove Remove or delete operations
Rename Rename operations
Report Generic reports
ReportAccess Access reports
ReportAlarm Alarm reports
ReportAuditTrail Audit trail reports
ReportCameraActivity Camera activity reports
ReportCardholderConfiguration Cardholder configuration reports
ReportDoorActivity Door activity reports
Resources Resource configuration
Restart Restart operations
Save Save operations
Schedule Schedule entities
Search Search operations
SnapshotSave Saving snapshots
Success Successful states
Task Task privileges or task pages
Threat Threat level features
Unlock Unlock operations
User User entities
UserAdmin User administration
UserGroup User groups
VideoAnalytics Video analytics features
Visitor Visitor management
Warning Warnings
WebSDK Web SDK features
Zone Zone entities

HTTP endpoint reference

The Web SDK exposes a fixed set of HTTP endpoints organized by functional area. The tables below catalog every endpoint and link to the page that covers it in depth.

Entity endpoints

Endpoint Method Purpose
/entity/exists/{id} GET Check if entity exists
/entity/{id} GET Get complete entity data
/entity/basic/{id} GET Get basic entity properties only
/entity?q={query} GET/POST Read, create, update and execute actions
/entity/{id} DELETE Delete entity

See The /entity endpoint.

Events endpoints

Endpoint Method Purpose
/events GET Redirects to the streaming endpoint on the streaming port
/events/subscribe?q={query} GET Subscribe to events
/events/subscribed GET List current subscriptions
/events/unsubscribe?q={query} GET Unsubscribe from events
/events/closeconnection/{connectionId} POST Close streaming connection
/events/RaiseEvent/{eventType}/{entityId} POST Raise system event
/events/RaiseCustomEvent/{customEventId}/{entityId}/{message} POST Raise custom event
/events/alarmMonitoring/{onOrOff} POST Toggle alarm monitoring

See Monitoring events and alarms.

Alarm endpoints

Endpoint Method Purpose
/alarm?q={query} GET Trigger alarms, acknowledge, check status
/activealarms GET Get list of active alarms

See Monitoring events and alarms.

Report endpoints

Endpoint Method Purpose
/report/{reportType}?q={query} GET Execute reports with filters

See The /report endpoint.

Task endpoints

Endpoint Method Purpose
/tasks/public GET Get public saved tasks
/tasks/private GET Get private saved tasks
/tasks/execute/{guid} POST Execute saved task by GUID
/tasks/public/execute/{taskType}/{taskName} POST Execute public saved task
/tasks/private/execute/{taskType}/{taskName} POST Execute private saved task

See Executing saved tasks.

Action endpoints

Endpoint Method Purpose
/action?q={query} POST Execute action manager operations

See The /action endpoint.

Macro endpoints

Endpoint Method Purpose
/activemacros GET Get running macros list
/activemacrosdetails GET Get detailed running macros info

See Working with macros.

Incident endpoints

Endpoint Method Purpose
/incident?q={query} PUT Create incidents
/incident?q={query} GET Read incidents
/incident/{incidentGuid} GET Get specific incident

See The /incident endpoint.

Custom field endpoints

Endpoint Method Purpose
/customField/{entityId}/{customFieldName} GET Get custom field value
/customField/{entityId}/{customFieldName}/{value} PUT Set custom field value
/customField/{entityType}/{customFieldName}/{dataType}/{defaultValue} POST Create custom field
/customField/{entityType}/{customFieldName}/Encrypt/{dataType}/{defaultValue} POST Create encrypted custom field
/customField/{entityType}/{customFieldName} DELETE Delete custom field

See Working with custom fields.

Configuration endpoints

Endpoint Method Purpose
/ GET Test service online status
/GetWebTokenEncoded GET Get encoded web token
/GetWebTokenDecoded GET Get decoded web token
/creationpartition/{partitionIds} POST Set default creation partitions
/ignoreremoteexception/{state} POST Configure exception handling

See Querying system information for web tokens and exception handling, Getting started with the Web SDK for keep-alive and session details, and Working with partitions for creation partitions.

Custom entity type endpoints

Endpoint Method Purpose
/customEntityType/all GET Get all custom entity types
/customEntityType/{customEntityTypeDescriptorId} GET Get specific custom entity type
/customEntityType/{customEntityTypeDescriptorId} DELETE Delete custom entity type

See Managing custom entity types.

Custom card format endpoints

Endpoint Method Purpose
/customCardFormats/all GET Get all custom card formats
/customCardFormats/getByName/{name} GET Get card format by name
/customCardFormats/getByFormatId/{formatId} GET Get card format by format ID
/customCardFormats/getById/{id} GET Get card format by ID
/customCardFormats/add POST Create new custom card format
/customCardFormats/updateByName/{name} PUT Update card format by name
/customCardFormats/updateByFormatId/{formatId} PUT Update card format by format ID
/customCardFormats/updateById/{id} PUT Update card format by ID
/customCardFormats/deleteByName/{name} DELETE Delete card format by name
/customCardFormats/deleteByFormatId/{formatId} DELETE Delete card format by format ID
/customCardFormats/deleteById/{id} DELETE Delete card format by ID
/customCardFormats/exportByName/{name} POST Export card format XML by name
/customCardFormats/exportByFormatId/{formatId} POST Export card format XML by format ID
/customCardFormats/exportById/{id} POST Export card format XML by ID

See The /customCardFormats endpoint.

License usage endpoints

Endpoint Method Purpose
/licenseItemUsage GET Get license usage information
/licenseItemUsage/{name} GET Get specific license item usage

See License usage.

See also

Platform SDK

Plugin SDK

Workspace SDK

Media SDK

Macro SDK

Web SDK

Media Gateway

Genetec Web Player

Clone this wiki locally