How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems Component Webservice API

The Component Webservice API from Rhombus Systems — 62 operation(s) for component webservice.

Rhombus Systems Component Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Component Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 62 operations across 62 paths, and defines 277 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

62 operations 62 paths 277 schemas 62 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems Component Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Paths & Operations 62

Across 62 paths, the API surfaces 62 operations — 62 POST. Each is listed below with its method, path, parameters, and response codes.

Component Webservice 62
POST
/api/component/addAccessControlledDoorLabel
Create a label that can be assigned to an access controlled door
addAccessControlledDoorLabel 1 param body → 200
POST
/api/component/createAccessControlledDoor
Create an access controlled door
createAccessControlledDoor 1 param body → 200
POST
/api/component/createAccessControlledDoorSeekpoints
Create custom activity seekpoints for a specified access controlled door
createAccessControlledDoorSeekpoints 1 param body → 200
POST
/api/component/createIntegratedDoorPositionIndicator
Create a door position indicator component
createIntegratedDoorPositionIndicator 1 param body → 200
POST
/api/component/createIntegratedDoorRelay
Create a door relay component
createIntegratedDoorRelay 1 param body → 200
POST
/api/component/createIntegratedGenericButton
Create a generic button component
createIntegratedGenericButton 1 param body → 200
POST
/api/component/createIntegratedGenericInput
Create a generic input component
createIntegratedGenericInput 1 param body → 200
POST
/api/component/createIntegratedGenericRelay
Create a generic relay component
createIntegratedGenericRelay 1 param body → 200
POST
/api/component/createIntegratedRequestToExit
Create a request to exit component
createIntegratedRequestToExit 1 param body → 200
POST
/api/component/createOsdpDoorReader
Create a third party OSDP Reader component
createOsdpDoorReader 1 param body → 200
POST
/api/component/createRhombusOsdpDoorReader
Create a Rhombus OSDP Reader component
createRhombusOsdpDoorReader 1 param body → 200
POST
/api/component/createWiegandReader
Create a third party Wiegand Reader component
createWiegandReader 1 param body → 200
POST
/api/component/deleteAccessControlledDoor
Delete the specified access controlled door
deleteAccessControlledDoor 1 param body → 200
POST
/api/component/deleteComponent
Delete a component
deleteComponent 1 param body → 200
POST
/api/component/deleteComponentsByOwnerDevice
Delete all components owned by the specified device
deleteComponentsByOwnerDevice 1 param body → 200
POST
/api/component/findAccessControlledDoorShadows
Find access controlled door shadows within the org
findAccessControlledDoorShadows 1 param body → 200
POST
/api/component/findAccessControlledDoorShadowsByLocation
Find access controlled door shadows within the specified location
findAccessControlledDoorShadowsByLocation 1 param body → 200
POST
/api/component/findAccessControlledDoors
Find access controlled doors within the org
findAccessControlledDoors 1 param body → 200
POST
/api/component/findAccessControlledDoorsByLocation
Find access controlled doors within the specified location
findAccessControlledDoorsByLocation 1 param body → 200
POST
/api/component/findAccessControlledDoorsByOwnerDevice
Find access controlled doors for the specified owner device
findAccessControlledDoorsByOwnerDevice 1 param body → 200
POST
/api/component/findAllComponentShadows
Retrieve all component shadows for the specified component uuids
findAllComponentShadows 1 param body → 200
POST
/api/component/findComponentEventsByAccessControlledDoor
Retrieve all component events relevant to the specified AccessControlledDoor
findComponentEventsByAccessControlledDoor 1 param body → 200
POST
/api/component/findComponentEventsByApiToken
Retrieve all component events relevant to the specified api token
findComponentEventsByApiToken 1 param body → 200
POST
/api/component/findComponentEventsByComponent
Retrieve all component events relevant to the specified component
findComponentEventsByComponent 1 param body → 200
POST
/api/component/findComponentEventsByCorrelation
Retrieve all component events relevant to the specified correlation id
findComponentEventsByCorrelation 1 param body → 200
POST
/api/component/findComponentEventsByCredentialHexValue
Retrieve all component events relevant to the specified credential hex value
findComponentEventsByCredentialHexValue 1 param body → 200
POST
/api/component/findComponentEventsByCredentialUuid
Retrieve all component events relevant to the specified credential uuid
findComponentEventsByCredentialUuid 1 param body → 200
POST
/api/component/findComponentEventsByCredentialValue
Retrieve all component events relevant to the specified credential value
findComponentEventsByCredentialValue 1 param body → 200
POST
/api/component/findComponentEventsByGuestPass
Retrieve all component events relevant to the specified guest pass
findComponentEventsByGuestPass 1 param body → 200
POST
/api/component/findComponentEventsByLocation
Retrieve all component events relevant to the specified location
findComponentEventsByLocation 1 param body → 200
POST
/api/component/findComponentEventsByOwnerDevicedeprecated
Retrieve all component events relevant to the specified owner device (deprecated)
findComponentEventsByOwnerDevice 1 param body → 200
POST
/api/component/findComponentEventsBySupportAuthority
Retrieve all component events relevant to the specified support authority
findComponentEventsBySupportAuthority 1 param body → 200
POST
/api/component/findComponentEventsByUser
Retrieve all component events relevant to the specified User
findComponentEventsByUser 1 param body → 200
POST
/api/component/findComponentEventsForVideoIntercom
Retrieve all component events relevant to the specified Video Intercom and optional AccessControlledDoor
findComponentEventsForVideoIntercom 1 param body → 200
POST
/api/component/findComponentSeekPointsByAccessControlledDoor
Find component seekpoints by access controlled door
findComponentSeekPointsByAccessControlledDoor 1 param body → 200
POST
/api/component/findComponentSeekPointsByAccessControlledDoors
Find component seekpoints by access controlled doors
findComponentSeekPointsByAccessControlledDoors 1 param body → 200
POST
/api/component/findComponentSeekPointsByComponent
Find component seekpoints by component
findComponentSeekPointsByComponent 1 param body → 200
POST
/api/component/findComponentSeekPointsByLocation
Find component seekpoints by location
findComponentSeekPointsByLocation 1 param body → 200
POST
/api/component/findComponentSeekPointsByOwnerDevice
Find component seekpoints by owner device
findComponentSeekPointsByOwnerDevice 1 param body → 200
POST
/api/component/findComponentSeekPointsByUser
Find component seekpoints by user
findComponentSeekPointsByUser 1 param body → 200
POST
/api/component/findComponentShadowsByComponentComposites
Retrieve all component shadows for the components belonging to the specified component composites
findComponentShadowsByComponentComposites 1 param body → 200
POST
/api/component/findComponentShadowsByOwnerDevice
Retrieve component shadows by the specified owner device uuid
findComponentShadowsByOwnerDevice 1 param body → 200
POST
/api/component/findComponentsByOwnerDevice
Retrieve a list of components owned by a Rhombus device
findComponentsByOwnerDevice 1 param body → 200
POST
/api/component/findMinimalStateAccessControlledDoors
Find minimal state access controlled doors within the org
findMinimalStateAccessControlledDoors 1 param body → 200
POST
/api/component/findMinimalStateAccessControlledDoorsByLocation
Find minimal state access controlled doors within the specified location
findMinimalStateAccessControlledDoorsByLocation 1 param body → 200
POST
/api/component/findPaginatedComponentEventsByAccessControlledDoor
Retrieve all component events relevant to the specified AccessControlledDoor
findPaginatedComponentEventsByAccessControlledDoor 1 param body → 200
POST
/api/component/findPaginatedComponentEventsByOwnerDevice
Retrieve all component events relevant to the specified owner device
findPaginatedComponentEventsByOwnerDevice 1 param body → 200
POST
/api/component/getAccessControlledDoorLabelsForOrg
Get all access controlled door labels for the organization
getAccessControlledDoorLabelsForOrg 1 param body → 200
POST
/api/component/getOrCreateDevicePhysicalPortConfig
Get or create device physical port config
getOrCreateDevicePhysicalPortConfig 1 param body → 200
POST
/api/component/removeAccessControlledDoorLabel
Remove a label to an access controlled door
removeAccessControlledDoorLabel 1 param body → 200
POST
/api/component/updateAccessControlledDoor
Updates an access controlled door
updateAccessControlledDoor 1 param body → 200
POST
/api/component/updateIntegratedDoorPositionIndicator
Update a door position indicator component
updateIntegratedDoorPositionIndicator 1 param body → 200
POST
/api/component/updateIntegratedDoorRelay
Update a door relay component
updateIntegratedDoorRelay 1 param body → 200
POST
/api/component/updateIntegratedGenericButton
Update a generic button component
updateIntegratedGenericButton 1 param body → 200
POST
/api/component/updateIntegratedGenericInput
Update a generic input component
updateIntegratedGenericInput 1 param body → 200
POST
/api/component/updateIntegratedGenericRelay
Update a generic relay component
updateIntegratedGenericRelay 1 param body → 200
POST
/api/component/updateIntegratedGenericRelaySteadyState
Update a generic relay component's steady state
updateIntegratedGenericRelaySteadyState 1 param body → 200
POST
/api/component/updateIntegratedGenericRelayTransientState
Activate a generic relay for a brief period
updateIntegratedGenericRelayTransientState 1 param body → 200
POST
/api/component/updateIntegratedRequestToExit
Update a request to exit component
updateIntegratedRequestToExit 1 param body → 200
POST
/api/component/updateOsdpDoorReader
Update a third party OSDP Reader component
updateOsdpDoorReader 1 param body → 200
POST
/api/component/updateRhombusOsdpDoorReader
Update a Rhombus OSDP Reader component
updateRhombusOsdpDoorReader 1 param body → 200
POST
/api/component/updateWiegandDoorReader
Update a third party Wiegand Reader component
updateWiegandDoorReader 1 param body → 200

Schemas 277

The contract defines 277 schemas that model the data the API accepts and returns. The most detailed are AccessControlledDoorType (51 properties), Component_UpdateAccessControlledDoorWSRequest (32 properties), WiegandDoorReaderType (24 properties), RhombusOsdpDoorReaderType (24 properties). Each schema is shown below with its type and property counts.

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
ButtonEnumType
string
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
ActivityEnum
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
FirstInSourceEnum
string
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
ButtonPressEnum
string
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
AuxiliaryEnumType
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
DoorRelayEnumType
string
GenericInputShadowType
objectnull
6 properties
Component_CreateIntegratedDoorRelayWSRequest
object
3 properties
RequestToExitPhysicalPortEnumType
string
ComponentEnumType
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
FirstInStatusEnum
string
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-component-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Component Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.