Rhombus Systems Doorbell Camera Webservice API
The Doorbell Camera Webservice API from Rhombus Systems — 10 operation(s) for doorbell camera webservice.
The Doorbell Camera Webservice API from Rhombus Systems — 10 operation(s) for doorbell camera webservice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rhombus-systems-doorbell-camera-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: developer@rhombussystems.com
description: 'This API is for use by Rhombus customers and partners.
## Authentication
All requests require two headers:
- `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.
- `x-auth-apikey` — Your Rhombus API key.
Example:
```
POST /api/camera/getMinimalCameraStateList
x-auth-scheme: api-token
x-auth-apikey: YOUR_API_KEY
Content-Type: application/json
```'
title: Rhombus Doorbell Camera Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Doorbell Camera Webservice
paths:
/api/doorbellcamera/calibrateFloorplanProjection:
post:
description: Generate the homography to project detections onto a floorplan.
operationId: doorbellCameraCalibrateFloorplanProjection
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSResponse'
description: OK
summary: Generate the homography to project detections onto a floorplan
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/createRuleForDoorbellCamera:
post:
description: Create rule for a doorbell camera.
operationId: createRuleForDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSResponse'
description: OK
summary: Create rule for a doorbell camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/createSharedLiveVideoStream:
post:
description: Share an live video stream for a doorbell camera
operationId: createDoorbellCameraSharedLiveVideoStream
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSResponse'
description: OK
summary: Share an live video stream for a doorbell camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/delete:
post:
description: Remove the doorbell camera from the organization
operationId: deleteDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSResponse'
description: OK
summary: Remove the doorbell camera from the organization
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/deleteRuleForDoorbellCamera:
post:
description: Delete rule for a doorbell camera.
operationId: deleteRuleForDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse'
description: OK
summary: Delete rule for a doorbell camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/findComponentEventsForDoorbellCamera:
post:
description: Retrieve all component events relevant to the specified Doorbell Camera
operationId: findComponentEventsForDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified Doorbell Camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/findComponentSeekPointsForDoorbellCamera:
post:
description: Retrieve all component seekpoints relevant to the specified Doorbell Camera
operationId: findComponentSeekPointsForDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse'
description: OK
summary: Retrieve all component seekpoints relevant to the specified Doorbell Camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/findSharedLiveVideoStreams:
post:
description: Get list of all shared live streams for doorbell camera
operationId: findDoorbellCameraSharedLiveVideoStreams
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsWSResponse'
description: OK
summary: Get list of all shared live streams for doorbell camera
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/getDoorbellCameraRulesForOrg:
post:
description: Get rules for all doorbell cameras in an org.
operationId: getDoorbellCameraRulesForOrg
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse'
description: OK
summary: Get rules for all doorbell cameras in an org
tags:
- Doorbell Camera Webservice
/api/doorbellcamera/getRulesForDoorbellCamera:
post:
description: Get all rules for a doorbell camera.
operationId: getRulesForDoorbellCamera
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSResponse'
description: OK
summary: Get all rules for a doorbell camera
tags:
- Doorbell Camera Webservice
components:
schemas:
SupervisionStateEnumType:
type: string
enum:
- CUT_DETECTED
- SHORT_DETECTED
- NORMAL
- INVALID
- UNKNOWN
AperioActivatorStateEvent:
type:
- object
- 'null'
allOf:
- type: object
properties:
componentCompositeUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
state:
type:
- integer
- 'null'
format: int32
stateUpdatedAtMs:
type:
- integer
- 'null'
format: int64
properties:
componentUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
correlationId:
type:
- string
- 'null'
createdAtMs:
type:
- integer
- 'null'
format: int64
locationUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
ownerDeviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
subLocationsHierarchyKey:
type:
- string
- 'null'
format: SubLocationsHierarchyKey
description: 'A sequence of one or more base 64 (url-safe) uuid substrings.
These substrings are separated by dots (.).
'
example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
timestampMs:
type:
- integer
- 'null'
format: int64
type:
$ref: '#/components/schemas/ComponentEventEnumType'
uuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
ConnectAudioDeviceToMobileAppActionType:
type: object
properties:
audioDeviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
deviceType:
$ref: '#/components/schemas/DeviceTypeEnum'
doorUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
targetUserUuids:
type:
- array
- 'null'
items:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
UserEventOriginator:
type:
- object
- 'null'
allOf:
- type: object
properties:
userEmail:
type:
- string
- 'null'
userUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
username:
type:
- string
- 'null'
properties:
type:
$ref: '#/components/schemas/EventOriginatorEnum'
Common_devices_CalibrateFloorplanProjectionWSRequest:
type: object
description: Request to calibrate floorplan projection for a device.
properties:
cameraImagePointsPermyriad:
type:
- array
- 'null'
description: List of camera image points in permyriad coordinates
items:
type:
- array
- 'null'
description: List of camera image points in permyriad coordinates
items:
type:
- integer
- 'null'
format: int32
description: List of camera image points in permyriad coordinates
deviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
floorplanImagePointsPermyriad:
type:
- array
- 'null'
description: List of floorplan image points in permyriad coordinates
items:
type:
- array
- 'null'
description: List of floorplan image points in permyriad coordinates
items:
type:
- integer
- 'null'
format: int32
description: List of floorplan image points in permyriad coordinates
Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse:
type: object
description: Response object containing component events for a doorbell camera.
properties:
componentEvents:
type:
- array
- 'null'
description: List of component events for the doorbell camera
items:
$ref: '#/components/schemas/ComponentEventType'
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
DoorLockdownStateEventReference:
type:
- object
- 'null'
properties:
activatedLockdownPlan:
$ref: '#/components/schemas/LockdownPlanReference'
activeLockdownPlan:
$ref: '#/components/schemas/LockdownPlanReference'
deactivatedLockdownPlan:
$ref: '#/components/schemas/LockdownPlanReference'
doorEventUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
doorUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
PointType:
type: object
properties:
x:
type:
- integer
- 'null'
format: int32
y:
type:
- integer
- 'null'
format: int32
Doorbellcamera_CreateSharedLiveVideoStreamWSRequest:
type: object
description: Request object for creating a shared live video stream for a doorbell camera.
properties:
audioGatewayUuid:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
doorbellCameraUuid:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
expirationTimeSecs:
type:
- integer
- 'null'
format: int32
description: Add a expiration date for accessing the stream in seconds
example: 86400
invertSchedule:
type:
- boolean
- 'null'
description: If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise
example: false
name:
type:
- string
- 'null'
description: If not provided, will be named 'Unnamed'
example: Front Door Stream
password:
type:
- string
- 'null'
description: Add a password to allow access to your shared stream. If null or blank password is not set.
example: mypassword123
scheduleUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
streamType:
$ref: '#/components/schemas/StreamTypeEnum'
vodEnabled:
type:
- boolean
- 'null'
description: Enables recording of live footage to a VOD
example: true
required:
- doorbellCameraUuid
- streamType
- vodEnabled
AperioKeyCylinderStateEvent:
type:
- object
- 'null'
allOf:
- type: object
properties:
componentCompositeUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
state:
type:
- integer
- 'null'
format: int32
stateUpdatedAtMs:
type:
- integer
- 'null'
format: int64
properties:
componentUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
correlationId:
type:
- string
- 'null'
createdAtMs:
type:
- integer
- 'null'
format: int64
locationUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
ownerDeviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
subLocationsHierarchyKey:
type:
- string
- 'null'
format: SubLocationsHierarchyKey
description: 'A sequence of one or more base 64 (url-safe) uuid substrings.
These substrings are separated by dots (.).
'
example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
timestampMs:
type:
- integer
- 'null'
format: int64
type:
$ref: '#/components/schemas/ComponentEventEnumType'
uuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
CredentialEntry:
type:
- object
- 'null'
discriminator:
propertyName: credSource
oneOf:
- $ref: '#/components/schemas/CredentialEntryBleWave'
properties:
credSource:
$ref: '#/components/schemas/CredentialSourceEnumType'
credentialId:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
firstInEligible:
type:
- boolean
- 'null'
originator:
$ref: '#/components/schemas/BaseEventOriginator'
AccessControlAuthorizationResultEnumType:
type: string
enum:
- ALLOWED
- DENIED
- DISABLED
- ERROR
- NA
DoorPositionIndicatorStateChangeEventType:
type:
- object
- 'null'
allOf:
- type: object
properties:
componentCompositeUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
newState:
$ref: '#/components/schemas/DoorPositionIndicatorStateEnumType'
newSupervisionState:
$ref: '#/components/schemas/SupervisionStateEnumType'
properties:
componentUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
correlationId:
type:
- string
- 'null'
createdAtMs:
type:
- integer
- 'null'
format: int64
locationUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
ownerDeviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
subLocationsHierarchyKey:
type:
- string
- 'null'
format: SubLocationsHierarchyKey
description: 'A sequence of one or more base 64 (url-safe) uuid substrings.
These substrings are separated by dots (.).
'
example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
timestampMs:
type:
- integer
- 'null'
format: int64
type:
$ref: '#/components/schemas/ComponentEventEnumType'
uuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
StreamTypeEnum:
type: string
enum:
- USER
- ALARM_MONITORING
- DICE
- LUMEO
- INFORMACAST
- RAPIDSOS
- UNKNOWN
CredentialSourceEnumType:
type: string
enum:
- UNKNOWN
- NFC
- BLE_WAVE
- BLE
- WIEGAND
- REMOTE
- REMOTE_ADMIN
- UNK_3P_OSDP
- APERIO_NFC
- APERIO_LF
- APERIO_KEYPAD
- KEYPAD_WIEGAND
- KEYPAD_OSDP
- BLE_PROX
- QR_CODE
ComponentEventType:
type: object
description: List of component events for the doorbell camera
discriminator:
propertyName: type
oneOf:
- $ref: '#/components/schemas/DoorbellEventType'
- $ref: '#/components/schemas/DoorReaderStateChangeEventType'
- $ref: '#/components/schemas/DoorRelayStateChangeEventType'
- $ref: '#/components/schemas/DoorPositionIndicatorStateChangeEventType'
- $ref: '#/components/schemas/RequestToExitStateChangeEventType'
- $ref: '#/components/schemas/CredentialReceivedEventType'
- $ref: '#/components/schemas/ButtonEventType'
- $ref: '#/components/schemas/GenericInputStateChangeEventType'
- $ref: '#/components/schemas/GenericRelayStateChangeEventType'
- $ref: '#/components/schemas/AccessControlUnitTamperEventType'
- $ref: '#/components/schemas/AccessControlUnitLocationLockdownStateEventType'
- $ref: '#/components/schemas/DoorLocationLockdownStateEventType'
- $ref: '#/components/schemas/PanicButtonEventType'
- $ref: '#/components/schemas/AccessControlUnitBatteryStateChangeEventType'
- $ref: '#/components/schemas/WaveToUnlockIntentExpiredEvent'
- $ref: '#/components/schemas/DoorStateChangeEvent'
- $ref: '#/components/schemas/DoorAuthFirstInStateEvent'
- $ref: '#/components/schemas/DoorScheduleFirstInStateEvent'
- $ref: '#/components/schemas/AccessControlUnitDoorFirstInStateEvent'
- $ref: '#/components/schemas/AperioDtcEvent'
- $ref: '#/components/schemas/AperioDoorExtensionStateEvent'
- $ref: '#/components/schemas/AperioActivatorStateEvent'
- $ref: '#/components/schemas/AperioDoorModeEvent'
- $ref: '#/components/schemas/AperioDoorHandleStateEvent'
- $ref: '#/components/schemas/AperioKeyCylinderStateEvent'
- $ref: '#/components/schemas/IntercomTalkEventType'
properties:
componentUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
correlationId:
type:
- string
- 'null'
createdAtMs:
type:
- integer
- 'null'
format: int64
locationUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
ownerDeviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
subLocationsHierarchyKey:
type:
- string
- 'null'
format: SubLocationsHierarchyKey
description: 'A sequence of one or more base 64 (url-safe) uuid substrings.
These substrings are separated by dots (.).
'
example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
timestampMs:
type:
- integer
- 'null'
format: int64
type:
$ref: '#/components/schemas/ComponentEventEnumType'
uuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
AccessStateOverrideExpirationStrategyEnum:
type: string
enum:
- TIME_DELAY
- TIME_OF_DAY_LOCAL
- NONE
ChangeComponentCompositeAccessStateActionType:
type: object
properties:
accessState:
$ref: '#/components/schemas/AccessControlledDoorStateEnumType'
alwaysCreateOverrideIfNoFirstIn:
type:
- boolean
- 'null'
componentCompositeUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
expirationStrategy:
$ref: '#/components/schemas/AccessStateOverrideExpirationStrategyEnum'
expireTimeDelaySeconds:
type:
- integer
- 'null'
format: int64
expireTimeOfDayLocalSeconds:
type:
- integer
- 'null'
format: int64
useFirstInRulesIfPossible:
# --- truncated at 32 KB (153 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-doorbell-camera-webservice-api-openapi.yml