The identity and technical contract details declared by the specification.
Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest
object
Component seekpoints search for access controlled doors
4 properties
AccessControlledDoorShadow
object
9 properties
SupervisionStateEnumType
string
IntegratedRequestToExitType
object
15 properties
Component_CreateIntegratedGenericInputWSResponse
object
1 property
Component_UpdateIntegratedRequestToExitWSRequest
object
6 properties
Component_FindComponentSeekPointsByAccessControlledDoorWSResponse
object
1 property
Component_UpdateIntegratedGenericRelayTransientStateWSRequest
object
5 properties
Component_GetAccessControlledDoorLabelsForOrgWSResponse
object
1 property
AperioActivatorStateEvent
objectnull
10 properties
AperioGateway
object
14 properties
ComponentReferenceType
object
2 properties
IntegratedGenericRelayType
object
16 properties
Component_FindPaginatedComponentEventsByOwnerDeviceWSResponse
object
Response object for getting list of component events for the specified owner device with pagination support.
5 properties
UserEventOriginator
objectnull
1 property
WiegandOutputPortType
object
3 properties
SupervisionModeEnumType
string
DoorLockdownStateEventReference
objectnull
5 properties
AperioKeyCylinderStateEvent
objectnull
10 properties
CredentialEntry
objectnull
4 properties
AccessControlAuthorizationResultEnumType
string
Component_DeleteComponentWSResponse
object
Component_CreateIntegratedGenericInputWSRequest
object
4 properties
Component_DeleteAccessControlledDoorWSResponse
object
1 property
Component_FindComponentEventsByApiTokenWSResponse
object
1 property
DoorPositionIndicatorStateChangeEventType
objectnull
10 properties
Component_UpdateAccessControlledDoorWSRequest
object
32 properties
Component_FindComponentEventsByCorrelationWSRequest
object
5 properties
Component_FindComponentShadowsByComponentCompositesWSRequest
object
1 property
CredentialSourceEnumType
string
Component_FindComponentSeekPointsByLocationWSRequest
object
3 properties
ComponentEventType
object
List of component events for the doorbell camera
10 properties
Component_FindComponentEventsByAccessControlledDoorWSRequest
object
5 properties
FirstInState
object
3 properties
Component_CreateAccessControlledDoorWSRequest
object
2 properties
GenericButtonStateEnumType
string
Component_DeleteComponentWSRequest
object
1 property
RequestToExitEnumType
string
InvalidPhysicalPortReasonEnumType
string
LocationLockdownStateEnumType
string
WaveToUnlockIntentExpiredEvent
objectnull
10 properties
Component_UpdateIntegratedGenericInputWSRequest
object
4 properties
WaveToUnlockSettingsType
object
5 properties
ButtonPortType
object
3 properties
AperioDoorPositionIndicator
objectnull
10 properties
Component_UpdateIntegratedGenericRelaySteadyStateWSResponse
object
1 property
Component_AddAccessControlledDoorLabelWSResponse
object
DoorRelayPhysicalPortEnumType
string
ReaderDispositionEnum
string
Component_FindComponentSeekPointsByLocationWSResponse
object
1 property
Component_CreateRhombusOsdpReaderWSResponse
object
1 property
AccessControlledDoorType
object
51 properties
PortSupervisionConfigurationType
object
1 property
Component_UpdateIntegratedDoorRelayWSResponse
object
1 property
Component_FindComponentSeekPointsByAccessControlledDoorsWSResponse
object
1 property
Component_UpdateRhombusOsdpReaderWSResponse
object
1 property
Component_FindAccessControlledDoorsByOwnerDeviceWSRequest
object
1 property
DoorPositionIndicatorPhysicalPortEnumType
string
Component_CreateIntegratedGenericButtonWSRequest
object
4 properties
ManualAccessStateChangeEnum
string
Component_UpdateWiegandReaderWSResponse
object
1 property
Component_CreateIntegratedDoorPositionIndicatorWSResponse
object
1 property
Component_CreateIntegratedRequestToExitWSRequest
object
6 properties
BoardPhysicalPortConfigType
object
3 properties
Component_MinimalStateAccessControlledDoor
object
2 properties
Component_FindComponentEventsByCredentialHexValueWSRequest
object
5 properties
ComponentCompositeShadowEnum
string
Component_FindAccessControlledDoorShadowsByLocationWSRequest
object
3 properties
BaseEventOriginator
object
1 property
Component_FindComponentEventsByGuestPassWSRequest
object
5 properties
GenericRelayStateEnumType
string
Component_CreateWiegandReaderWSResponse
object
1 property
Component_GetOrCreateDevicePhysicalPortConfigWSRequest
object
1 property
Component_CreateAccessControlledDoorSeekpointsWSResponse
object
4 properties
Component_FindAccessControlledDoorsWSResponse
object
2 properties
WiegandDataPhysicalPortEnumType
string
GuestPassEventOriginator
objectnull
1 property
DeviceServiceEventOriginator
objectnull
1 property
IntegratedGenericInputType
object
13 properties
Component_FindComponentEventsByCredentialUuidWSResponse
object
1 property
DoorReaderStateChangeEventType
objectnull
10 properties
Component_UpdateOsdpReaderWSRequest
object
7 properties
Component_FindComponentEventsByCredentialValueWSRequest
object
5 properties
Component_FindComponentSeekPointsByOwnerDeviceWSRequest
object
Component seekpoints search for owner device
3 properties
CredentialReceivedEventType
objectnull
10 properties
RequestToExitStateChangeEventType
objectnull
10 properties
Component_UpdateIntegratedGenericRelayWSResponse
object
1 property
AccessControlledDoorSubTypeEnum
string
OsdpPhysicalPortEnumType
string
Component_AddAccessControlledDoorLabelWSRequest
object
2 properties
DoorPositionIndicatorEnumType
string
Component_FindComponentEventsByComponentWSResponse
object
1 property
AccessStateSourceEnum
string
PanicButtonEventType
objectnull
10 properties
AuxiliaryRelayPhysicalPortEnumType
string
AuxiliaryInputPortType
object
4 properties
AccessControlUnitDoorFirstInStateEvent
objectnull
10 properties
SupportAuthorityEventOriginator
objectnull
1 property
RuleEventOriginator
objectnull
1 property
CredentialEntryBleWave
objectnull
4 properties
Component_FindComponentsByOwnerDeviceWSResponse
object
1 property
Component_UpdateIntegratedGenericRelayTransientStateWSResponse
object
1 property
PhysicalPortType
object
5 properties
AperioDoorRelay
objectnull
10 properties
Component_UpdateIntegratedGenericRelaySteadyStateWSRequest
object
2 properties
Component_FindComponentSeekPointsByComponentWSRequest
object
3 properties
Component_FindComponentSeekPointsByComponentWSResponse
object
1 property
Component_FindMinimalStateAccessControlledDoorsWSRequest
object
2 properties
Component_CreateOsdpReaderWSRequest
object
8 properties
RhombusOsdpDoorReaderType
object
24 properties
Component_DeleteAccessControlledDoorWSRequest
object
1 property
AccessControlUnitLocationLockdownStateEventType
objectnull
10 properties
DoorReaderShadowType
objectnull
6 properties
DoorPositionIndicatorShadowType
objectnull
6 properties
Component_FindComponentEventsByOwnerDeviceWSResponse
object
1 property
DoorPositionIndicatorStateEnumType
string
RequestToExitShadowType
objectnull
6 properties
Component_CreateIntegratedDoorRelayWSResponse
object
1 property
DoorPositionIndicatorPortType
object
4 properties
GenericInputStateChangeEventType
objectnull
10 properties
DoorRelayStateEnumType
string
DoorRelayPortType
object
3 properties
FirstInShadow
object
4 properties
WiegandOutputPhysicalPortEnumType
string
Component_FindComponentEventsByLocationWSResponse
object
1 property
Component_FindComponentEventsForVideoIntercomWSRequest
object
6 properties
ButtonPhysicalPortEnumType
string
FirstInFirmwareStatusEnum
string
IntercomTalkStateEnumType
string
Whether the operator started or ended talking
Component_CreateIntegratedGenericButtonWSResponse
object
1 property
Component_FindComponentEventsByApiTokenWSRequest
object
5 properties
Component_CreateWiegandReaderWSRequest
object
13 properties
PhysicalPortEnumType
string
AuxiliaryInputPhysicalPortEnumType
string
AuxiliaryRelayPortType
object
3 properties
AccessControlUnitBatteryStateChangeEventType
objectnull
10 properties
LockdownPlanScopeEnumType
string
ComponentEventEnumType
string
Limits results to only contain the specified type of events, if applicable
WiegandDataPortType
object
3 properties
Component_FindComponentEventsBySupportAuthorityWSResponse
object
1 property
Component_DeleteComponentsByOwnerDeviceWSResponse
object
OsdpDoorReaderType
object
20 properties
Component_FindAccessControlledDoorShadowsWSRequest
object
2 properties
WiegandCredentialEndianEnumType
string
AperioDoorExtension
objectnull
10 properties
3 required
IntercomTalkEventType
objectnull
10 properties
DoorRelayShadowType
objectnull
6 properties
Component_FindComponentSeekPointsByUserWSRequest
object
3 properties
DoorReaderEnumType
string
Component_FindComponentEventsByCredentialHexValueWSResponse
object
1 property
Component_FindAccessControlledDoorsWSRequest
object
2 properties
DoorStateChangeEvent
objectnull
10 properties
Component_FindComponentEventsByGuestPassWSResponse
object
1 property
AperioDoorHandleStateEvent
objectnull
10 properties
ComponentShadowEnumType
string
ProximityUnlockSettingsType
object
8 properties
DevicePhysicalPortConfigType
object
5 properties
Component_FindComponentSeekPointsByUserWSResponse
object
1 property
AperioDoorExtensionStateEvent
objectnull
10 properties
Component_UpdateIntegratedGenericInputWSResponse
object
1 property
ComponentSeekPointType
object
List of component seekpoints for the doorbell camera
14 properties
IntegratedDoorPositionIndicatorType
object
13 properties
Component_UpdateWiegandReaderWSRequest
object
13 properties
Component_FindMinimalStateAccessControlledDoorsByLocationWSRequest
object
3 properties
Component_UpdateIntegratedRequestToExitWSResponse
object
1 property
Component_CreateAccessControlledDoorWSResponse
object
4 properties
BaseAccessStateOverride
object
3 properties
AperioDtcEvent
objectnull
10 properties
Component_FindComponentEventsByUserWSRequest
object
5 properties
Component_FindComponentSeekPointsByOwnerDeviceWSResponse
object
1 property
DoorScheduleFirstInStateEvent
objectnull
10 properties
AperioDoorExtensionShadow
objectnull
6 properties
Component_FindComponentEventsByLocationWSRequest
object
5 properties
Component_FindAccessControlledDoorsByLocationWSResponse
object
2 properties
Component_FindAccessControlledDoorShadowsByLocationWSResponse
object
2 properties
DtcInfo
objectnull
5 properties
AccessStateShadow
object
4 properties
Component_UpdateOsdpReaderWSResponse
object
1 property
NormalStateEnumType
string
WiegandInputPortType
object
3 properties
Component_UpdateRhombusOsdpReaderWSRequest
object
7 properties
Component_CreateIntegratedGenericRelayWSResponse
object
1 property
LockdownPlanReference
object
3 properties
Component_CreateOsdpReaderWSResponse
object
1 property
AccessControlUnitTamperEventType
objectnull
10 properties
HardwareVariationEnum
string
ButtonModeEnum
string
Optional button mode configuration
Component_FindComponentEventsByCredentialValueWSResponse
object
1 property
InvalidPhysicalPortConfigType
object
4 properties
WiegandInputPhysicalPortEnumType
string
Component_FindMinimalStateAccessControlledDoorsByLocationWSResponse
object
2 properties
EventOriginatorEnum
string
DoorLockdownStateEnumType
string
FootageSeekPointColorEnum
string
AccessControlUnitTamperSourceEnumType
string
Component_FindAllComponentShadowsWSRequest
object
1 property
Component_FindMinimalStateAccessControlledDoorsWSResponse
object
2 properties
Component_CreateAccessControlledDoorSeekpointsWSRequest
object
2 properties
ComponentCompositeEventOriginator
objectnull
1 property
Component_GetOrCreateDevicePhysicalPortConfigWSResponse
object
3 properties
Component_FindPaginatedComponentEventsByOwnerDeviceWSRequest
object
8 properties
DoorAuthFirstInStateEvent
objectnull
10 properties
Component_FindComponentEventsForVideoIntercomWSResponse
object
4 properties
RequestToExitStateEnumType
string
OsdpReaderPortType
object
3 properties
DoorLocationLockdownStateEventType
objectnull
10 properties
Component_UpdateIntegratedGenericButtonWSRequest
object
4 properties
DoorFirstInStateChangeEventReference
objectnull
7 properties
GenericInputShadowType
objectnull
6 properties
Component_CreateIntegratedDoorRelayWSRequest
object
3 properties
RequestToExitPhysicalPortEnumType
string
IntegratedDoorRelayType
object
13 properties
AperioGatewayShadow
objectnull
6 properties
IntegratedGenericButtonType
object
13 properties
Component_CreateIntegratedDoorPositionIndicatorWSRequest
object
4 properties
Component_FindPaginatedComponentEventsByAccessControlledDoorWSRequest
object
8 properties
Component_UpdateIntegratedDoorRelayWSRequest
object
3 properties
Component_FindComponentShadowsByOwnerDeviceWSResponse
object
1 property
Component_FindComponentEventsByComponentWSRequest
object
5 properties
BaseComponentType
object
10 properties
Component_FindComponentEventsBySupportAuthorityWSRequest
object
5 properties
Component_FindAllComponentShadowsWSResponse
object
1 property
ButtonEventType
objectnull
10 properties
Component_FindAccessControlledDoorShadowsWSResponse
object
2 properties
AperioDoorReader
objectnull
10 properties
GenericRelayStateChangeEventType
objectnull
10 properties
AperioDoorModeEvent
objectnull
10 properties
Component_UpdateIntegratedDoorPositionIndicatorWSRequest
object
4 properties
Component_FindComponentEventsByAccessControlledDoorWSResponse
object
4 properties
ComponentCompositeEnumType
string
DoorReaderStateEnumType
string
Component_GetAccessControlledDoorLabelsForOrgWSRequest
object
GenericInputStateEnumType
string
Component_FindComponentSeekPointsByAccessControlledDoorWSRequest
object
Component seekpoints search for access controlled door
3 properties
AuthDecisionSourceEnum
string
DoorRelayStateChangeEventType
objectnull
10 properties
GenericRelayShadowType
objectnull
6 properties
AccessControlledDoorStateEnumType
string
Component_UpdateAccessControlledDoorWSResponse
object
4 properties
Component_FindComponentEventsByCorrelationWSResponse
object
1 property
Component_DeleteComponentsByOwnerDeviceWSRequest
object
1 property
Component_RemoveAccessControlledDoorLabelWSResponse
object
RequestToExitPortType
object
4 properties
DoorReaderStateChangeReasonEnumType
string
Component_CreateIntegratedGenericRelayWSRequest
object
4 properties
Component_FindComponentEventsByCredentialUuidWSRequest
object
5 properties
GenericButtonShadowType
objectnull
6 properties
CustomFootageSeekPointType
object
List of custom footage seek points to create
5 properties
2 required
Component_UpdateIntegratedGenericButtonWSResponse
object
1 property
WiegandDoorReaderType
object
24 properties
Component_FindComponentsByOwnerDeviceWSRequest
object
1 property
Component_RemoveAccessControlledDoorLabelWSRequest
object
2 properties
Component_FindComponentEventsByUserWSResponse
object
1 property
Component_FindComponentEventsByOwnerDeviceWSRequest
object
5 properties
Component_UpdateIntegratedGenericRelayWSRequest
object
3 properties
DoorbellEventType
objectnull
10 properties
AccessControlAuthenticationResultEnumType
string
Component_FindComponentShadowsByComponentCompositesWSResponse
object
1 property
ApiTokenEventOriginator
objectnull
1 property
AntiPassbackModeEnum
string
Component_FindComponentShadowsByOwnerDeviceWSRequest
object
1 property
Component_FindAccessControlledDoorsByLocationWSRequest
object
3 properties
Component_CreateRhombusOsdpReaderWSRequest
object
8 properties
ComponentBaseEnumType
string
Component_FindPaginatedComponentEventsByAccessControlledDoorWSResponse
object
Request object for getting list of component events for the specified door with pagination support.
5 properties
ComponentShadowType
object
6 properties
Component_CreateIntegratedRequestToExitWSResponse
object
1 property
Component_UpdateIntegratedDoorPositionIndicatorWSResponse
object
1 property
Component_FindAccessControlledDoorsByOwnerDeviceWSResponse
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Rhombus Systems publishes across the network.