The identity and technical contract details declared by the specification.
ConnectAudioDeviceToMobileAppActionType
object
4 properties
PointType
object
2 properties
AccessStateOverrideExpirationStrategyEnum
string
ChangeComponentCompositeAccessStateActionType
object
8 properties
BaseLocationLockdownEventOriginator
object
1 property
LocationLockdownStateEnumType
string
Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest
object
Request to retrieve all lockdown rules for a specific location.
1 property
ReportLookbackTypeEnum
string
EnableDisableAudioRecordActionType
object
2 properties
IntegrationNotificationActionType
object
3 properties
NoOpAction
objectnull
2 properties
Accesscontrol_lockdownplan_GetLockdownPlanWSResponse
object
Response containing the requested lockdown plan.
1 property
SensorValType
object
3 properties
Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse
object
Response containing the UUID of the created lockdown rule.
4 properties
CreateAlarmTriggerTypeEnum
string
ComponentRelayOutputTypeEnum
string
CancelLoopingAudioPlaybackActionType
object
2 properties
ToastOrderIdType
object
5 properties
RuleActionType
object
The action to take when this lockdown rule is triggered.
21 properties
Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse
object
Response containing the created location lockdown plan.
1 property
ActivateLocationLockdownActionType
object
2 properties
Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest
object
Request to find lockdown events for a specific location with optional time filtering.
4 properties
1 required
CustomRuleAction
object
2 properties
Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse
object
Response containing the updated lockdown state after enabling test mode.
1 property
BaseLockdownStateEventType
object
List of lockdown events found for the specified location.
7 properties
GenericRelayStateEnumType
string
AudioPlaybackActionType
object
4 properties
Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest
object
Request to enable test mode for lockdown at a specific location.
1 property
LocationLockdownPlanType
object
The updated location lockdown plan.
14 properties
Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest
object
Request to disable test mode for lockdown at a specific location.
1 property
Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest
object
Request to create a new lockdown rule for a specific location.
1 property
ReportLookbackUnitEnum
string
ActivityEventData
object
4 properties
Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse
object
Response containing the result of activating lockdown for a location.
2 properties
Accesscontrol_lockdownplan_FindLockdownPlansWSRequest
object
Request to search for lockdown plans across the organization.
TriggerComponentRelayActionType
object
7 properties
Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest
object
Request to find location lockdown states with optional filtering.
1 property
Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest
object
Request to retrieve an existing lockdown state or create one for a specific location.
1 property
Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse
object
Response indicating successful deletion of location lockdown state.
LockdownTestPlanType
object
2 properties
Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse
object
Response confirming the deletion of a lockdown plan.
2 properties
NavigationTypeEnum
string
LockdownPlanScopeEnumType
string
EmailAuditLogExportActionType
object
7 properties
ConnectAudioDeviceToPhoneNumberActionType
object
5 properties
Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse
object
Response containing a list of lockdown rules for a specific location.
4 properties
ThirdPartyAudioPlaybackActionType
object
7 properties
LockdownActivationPlanType
object
3 properties
RobotActionTypeEnum
string
RobotAction
object
2 properties
Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest
object
Request to delete a specific lockdown plan by UUID.
1 property
Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse
object
Response indicating successful deletion of a lockdown rule.
3 properties
IntegrationCommandActionType
object
3 properties
LockdownDeactivationPlanType
object
3 properties
Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse
object
Response containing a list of location lockdown states.
1 property
EmergencyContact
object
2 properties
2 required
Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse
object
Response containing the updated lockdown state after disabling test mode.
1 property
Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest
object
Request to delete a specific lockdown rule for a location.
2 properties
LockdownEventOriginatorEnumType
string
Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest
object
Request to create a new location lockdown plan.
1 property
LockdownPlanReference
object
3 properties
ClipBoundingBoxType
object
25 properties
LockdownPhysicalAccessType
object
2 properties
FootageSeekPointColorEnum
string
DoorLockdownStateEnumType
string
Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest
object
Request to deactivate lockdown for a specific location with optional optimistic locking.
2 properties
Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse
object
Response containing the lockdown state for the specified location.
1 property
ToastCheckInfo
object
1 property
Accesscontrol_lockdownplan_GetLockdownPlanWSRequest
object
Request to retrieve a specific lockdown plan by UUID.
1 property
BaseLockdownPlanType
object
The requested lockdown plan.
13 properties
Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType
object
External representation of a lockdown plan rule configuration.
6 properties
ThirdPartyStrobeSirenActionType
object
12 properties
WebhookActionType
object
8 properties
RemoteDoorUnlockSystemEnum
string
Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse
object
Response containing a list of lockdown events for a specific location.
1 property
Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest
object
Request to search for lockdown plans for a specific location.
1 property
DeployRobotAction
objectnull
2 properties
Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest
object
Request to update an existing location lockdown plan with selective field updates.
8 properties
Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse
object
Response containing the updated location lockdown plan.
1 property
Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest
object
Request to activate lockdown for a specific location with optional optimistic locking.
3 properties
LocationLockdownStateType
object
The lockdown state for the location.
8 properties
RuleFilterType
object
Optional filters to apply to this lockdown rule.
2 properties
LockdownActivationResultEnumType
string
The result of the lockdown activation operation.
Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse
object
Response containing the result of deactivating lockdown for a location.
2 properties
AMSirenSettingsType
object
4 properties
2 required
Accesscontrol_lockdownplan_FindLockdownPlansWSResponse
object
Response containing a list of lockdown plans found in the organization.
1 property
LockdownDeactivationResultEnumType
string
The result of the lockdown deactivation operation.
AccessControlledDoorStateEnumType
string
CustomLLMActionType
object
5 properties
CreateAlarmActionType
object
11 properties
RemoteDoorUnlockActionType
object
3 properties
Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest
object
Request to delete the lockdown state tracking for a specific location.
1 property
LockdownStateEventEnumType
string
Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse
object
Response containing a list of lockdown plans found for the specified location.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Rhombus Systems publishes across the network.