The identity and technical contract details declared by the specification.
Camera_GetVideoWallsWSRequest
object
Request to retrieve all video wall configurations.
CameraVisualTamperConfigType
object
7 properties
Camera_FindAllSharedLiveVideoStreamsWSRequest
object
Request to find all shared live video streams.
Camera_GenerateWifiChangeAuthorizationTokenWSResponse
object
Response containing a WiFi change authorization token.
5 properties
Camera_CreateVideoWallWSRequest
object
Request to create a video wall.
1 property
Common_devices_CalibrateFloorplanProjectionWSRequest
object
Request to calibrate floorplan projection for a device.
3 properties
Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate
object
(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable li…
2 properties
PointType
object
2 properties
Camera_CameraPTZMoveWSRequest
object
Request object for moving a Rhombus first-party mechanical PTZ camera.
4 properties
Camera_GetPresenceWindowsWSRequest
object
Request to retrieve presence windows for a camera within a time range.
3 properties
Camera_SharedVideoWallWS
object
List of shared video walls
14 properties
Camera_GetFullCameraStateWSResponse
object
Response containing the full state information of a camera.
4 properties
Camera_GetCameraAIThresholdsWSRequest
object
Request to retrieve AI thresholds for a camera.
1 property
Camera_GetOfflineLanStreamingInfoWSRequest
object
Request to retrieve offline LAN streaming information for cameras.
Common_devices_GetUptimeWindowsForOrgWSResponse
object
Response containing uptime windows for many devices.
4 properties
Common_devices_rawstream_CreateRawHttpStreamWSRequest
object
Request to create a raw HTTP stream for a device.
3 properties
CloudArchivingStrategyEnum
string
Camera_DeleteCameraWSRequest
object
Request to delete a camera from the system.
2 properties
DeviceFacetEnum
string
facet information for media
Camera_GetMinimalListWSRequest
object
Request to retrieve a minimal list of cameras (deprecated).
1 property
CameraAiDewarpConfigType
object
3 properties
DeviceTargetScopeEnum
string
CrossingObjectEnum
string
Camera_DeleteSharedVideoWallWSRequest
object
Request to delete a shared video wall.
2 properties
Camera_GetFootageBoundingBoxesWSRequest
object
Request to retrieve footage bounding boxes for a camera within a time range.
3 properties
Camera_GetCurrentStateWSResponse
object
Response containing the current state of a camera (deprecated).
4 properties
Camera_GetMinimalListWSResponse
object
Response containing a minimal list of cameras (deprecated).
4 properties
RegionConfigType
objectnull
2 properties
SensorValType
object
3 properties
CameraMountingDirectionEnum
string
Camera_FindSharedVideoWallsWSResponse
object
Response containing shared video walls for a video wall.
4 properties
Camera_RebootCameraWSResponse
object
Response from rebooting a camera device.
4 properties
Camera_GetFullCameraStateWSRequest
object
Request to retrieve the full state information of a camera.
2 properties
ToastOrderIdType
object
5 properties
SeekpointIndexType
object
Matching integration access events. Each carries timestamp, device/location, the event label (customDisplayName), the cardholder name, badge status/type, enter…
18 properties
VideoWallType
object
Video wall configuration to update
8 properties
Camera_UpdateCameraV2WSResponse
object
Response indicating the result of updating camera information V2.
3 properties
CameraMotorConfigType
object
8 properties
Common_devices_rawstream_DeleteRawHttpStreamWSResponse
object
Response indicating the result of deleting raw HTTP streams.
3 properties
Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse
object
Response indicating the result of deleting seek points for a camera.
2 properties
Camera_UpdateCameraWSRequest
object
Request to update camera information (deprecated).
1 property
DeviceSchedule
object
3 properties
Camera_GetFootageBoundingBoxesWSResponse
object
Response containing footage bounding boxes for a camera.
4 properties
Camera_GetMinimalCameraLocationMapWSResponse
object
Response containing a mapping of cameras to their location information.
4 properties
RegionOfInterestGroup
object
3 properties
Common_devices_rawstream_FindAllRawHttpStreamsWSResponse
object
Response containing all raw HTTP streams.
4 properties
Camera_VideoWallSummaryType
object
Summary information for a video wall.
9 properties
Common_devices_GetUptimeWindowsForOrgWSRequest
object
Request to get uptime windows for many devices in a single call.
3 properties
AspectRatio
object
2 properties
Camera_GenerateBatchRegistrationInfoRequest
object
Request to generate batch registration information for cameras.
6 properties
Camera_EraseCameraWSRequest
object
Request to permanently erase a camera from the system.
1 property
Camera_MinimalCameraType
object
Minimal camera information type.
22 properties
Camera_GetVideoWallsWSResponse
object
Response containing video wall configurations and associated user name mappings.
5 properties
DeleteSharedLiveVideoStreamForDeviceResponse
object
Camera_FindAllSharedLiveVideoStreamsWSResponse
object
Response containing all shared live video streams.
4 properties
Camera_DeleteVideoWallWSRequest
object
Request to delete a video wall configuration.
1 property
Camera_GetCameraDetailsWSResponse
object
Response containing detailed information for multiple cameras.
4 properties
Camera_GetPresenceWindowsWSResponse
object
Response containing presence windows for a camera.
4 properties
Common_devices_rawstream_GetRawHttpStreamsWSResponse
object
Response containing raw HTTP streams for a device.
4 properties
WeeklyMinuteIntervalType
object
2 properties
Camera_GetStorageRecoveryFileWSRequest
object
Request to get storage recovery file for a device.
1 property
DewarpedView
object
5 properties
Camera_CreateSharedLiveVideoStreamWSRequest
object
Request to create a shared live video stream for a camera.
11 properties
FootageBoundingBoxType
object
List of shared footage bounding boxes
26 properties
6 required
Camera_DeleteCustomFootageSeekpointsWSResponse
object
Response containing the results of deleting custom footage seek points.
4 properties
CameraCrossCountingSettingsType
object
5 properties
Camera_FindSharedLiveVideoStreamsWSResponse
object
Response containing shared live video streams.
4 properties
Camera_UpdateCamerasBulkV2WSRequest
object
Request to update multiple cameras in bulk V2.
1 property
Camera_CameraPTZMoveWSResponse
object
Response object for moving a Rhombus first-party mechanical PTZ camera.
3 properties
CameraMeteringConfigType
object
2 properties
Camera_CameraOfflineLanStreamingInfo
object
Information for offline LAN streaming.
2 properties
FootageSeekPointV2Type
object
List of shared footage seekpoints (deprecated)
27 properties
2 required
Camera_GetCurrentStateWSRequest
object
Request to retrieve the current state of a camera (deprecated).
2 properties
Camera_FindSharedLiveVideoStreamsForWSRequest
object
Request to find shared live video streams for a camera.
1 property
Common_devices_CalibrateFloorplanProjectionWSResponse
object
Response containing the calibrated floorplan projection homography.
1 property
Camera_CreateCustomFootageSeekpointsWSRequest
object
Request to create custom footage seek points for a camera.
2 properties
Camera_UpdateVideoWallWSRequest
object
Request to update a video wall configuration.
1 property
Camera_GetBatchRegistrationTokenUsageRequest
object
Request to retrieve batch registration token usage information.
2 properties
Common_devices_rawstream_FindAllRawHttpStreamsWSRequest
object
Request to retrieve all raw HTTP streams.
Camera_UpdateCameraAIThresholdsWSResponse
object
Response indicating the result of updating camera AI thresholds.
3 properties
Camera_GetFootageBoundingBoxesForMultipleWSRequest
object
Request to retrieve footage bounding boxes for multiple cameras within a time range.
3 properties
CameraInactivitySettingsType
object
3 properties
Camera_GetFootageSeekpointsForMultipleWSResponse
object
Response containing footage seek points for multiple cameras.
4 properties
FullDeviceStateType
object
Detailed state information for the specified NVR
44 properties
Camera_UpdateCameraFirmwareWSResponse
object
Response containing the status of camera firmware update.
4 properties
Camera_GetCameraAIThresholdsWSResponse
object
Response containing AI thresholds for a camera.
11 properties
CameraHumanLoiteringSettingsType
object
1 property
Camera_CreateSharedVideoWallWSRequest
object
Request to create a shared video wall.
6 properties
Camera_RevertCameraToDefaultsWSRequest
object
1 property
Camera_GetUptimeWindowsWSResponse
object
Response containing uptime windows for a camera.
4 properties
Camera_UpdateWifiWSRequest
object
Request to update WiFi settings for one or more cameras.
4 properties
Camera_CreateFootageBoundingBoxesWSRequest
object
Request to create footage bounding boxes for a camera.
2 properties
Camera_GetFootageBoundingBoxesForMultipleWSResponse
object
Response containing footage bounding boxes for multiple cameras.
4 properties
Camera_CreateFootageSeekpointsWSResponse
object
Response indicating the result of creating footage seek points.
3 properties
Camera_GetConfigWSRequest
object
Request to retrieve camera configuration settings.
1 property
CameraPTZConfigType
object
4 properties
Camera_UpdateCameraLineCrossingThresholdsWSResponse
object
Response indicating the result of updating camera line crossing thresholds.
3 properties
Camera_GetCloudArchivingConfigWSResponse
object
Response containing cloud archiving configuration.
4 properties
Camera_GetUptimeWindowsWSRequest
object
Request to retrieve uptime windows for a camera within a time range.
3 properties
CameraDewarpModeEnum
string
Camera_CreateFootageBoundingBoxesWSResponse
object
Response indicating the result of creating footage bounding boxes.
3 properties
Camera_UpdateVideoWallWSResponse
object
Response indicating the result of updating a video wall configuration.
3 properties
Camera_GenerateBatchRegistrationInfoResponse
object
Response containing batch registration information for cameras.
2 properties
Camera_DeleteCameraWSResponse
object
Response indicating the result of deleting a camera.
4 properties
Camera_RebootWSResponseStatus
string
Status enumeration for reboot web service responses.
Camera_GetCloudArchivedMediaInfoWSRequest
object
Request to retrieve cloud archived media information for a camera.
1 property
Camera_FootageSeekPointSummaryType
object
Summary of footage seek points with activity counts and metadata.
8 properties
Camera_GetCustomFootageSeekpointsV2WSRequest
object
Request to retrieve custom footage seek points V2 for cameras within a time range.
6 properties
Camera_StatusEnum
string
Status enumeration for camera states.
FisheyeDisplayModeEnum
string
Camera_DeleteSharedVideoWallWSResponse
object
Response indicating the result of deleting a shared video wall.
3 properties
Camera_HealthStatusDetailsEnum
string
Detailed health status enumeration for cameras.
Camera_DeleteVideoWallWSResponse
object
Response indicating the result of deleting a video wall configuration.
3 properties
Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo
object
Information about a camera's location.
3 properties
Camera_UpdateFirmwareWSStatus
string
Status of the firmware update operation
HardwareVariationEnum
string
Camera_GetCameraDetailsWSRequest
object
Request to retrieve detailed information for multiple cameras.
1 property
RegionCoordinateType
object
2 properties
Camera_UpdateCameraFirmwareWSRequest
object
Request to update camera firmware.
1 property
FootageSeekPointColorEnum
string
Camera_UpdateCameraWSResponse
object
Response indicating the result of updating camera information (deprecated).
3 properties
Camera_CameraBackwardsCompatUpdateType
object
Backwards compatible camera update type with optional fields.
12 properties
Device_config_userconfig_IExternalReadableAudioVideoUserConfig
object
Doorbell camera configuration settings
154 properties
Camera_RevertCameraToDefaultsWSResponse
object
3 properties
Camera_GetFootageSeekpointsV2WSRequest
object
Request to retrieve footage seek points V2 for a camera within a time range.
4 properties
Common_devices_rawstream_DeleteRawHttpStreamWSRequest
object
Request to delete raw HTTP streams for a device.
2 properties
ToastCheckInfo
object
1 property
TimeWindowSeconds
object
List of uptime windows for the device
2 properties
Camera_CameraExternalType
object
External camera type.
25 properties
Device_config_settings_ExternalVideoResolution
object
2 properties
Camera_GetCloudArchivedMediaInfoWSResponse
object
Response containing cloud archived media information for a camera.
4 properties
PermyriadRect
object
5 properties
Camera_GetFootageSeekpointsV2WSResponse
object
Response containing footage seek points V2 for a camera.
4 properties
Camera_GetConfigWSResponse
object
Response containing camera configuration settings.
4 properties
Camera_DeleteCustomFootageSeekpointsWSRequest
object
Request to delete custom footage seek points for cameras within a time range.
4 properties
Camera_EraseCameraWSResponse
object
Response indicating the result of erasing a camera.
3 properties
Camera_GetMinimalCameraStateListWSRequest
object
Request to retrieve a minimal list of camera states.
1 property
InactivityObjectTypeEnum
string
Camera_UpdateCameraLineCrossingThresholdsWSRequest
object
Request to update line crossing thresholds for a camera.
6 properties
Camera_GetCloudArchivingConfigWSRequest
object
Request to get cloud archiving configuration.
1 property
BatchRegistrationTokenUsageResult
object
List of batch registration token usage results
4 properties
Camera_GetFootageSeekpointsForMultipleWSRequest
object
Request to retrieve footage seek points for multiple cameras within a time range.
4 properties
Camera_UpdateWifiWSResponse
object
Response containing the status of WiFi update operations for each camera.
4 properties
Camera_FootageBoundingBoxSummaryType
object
Summary of footage bounding boxes by device.
1 property
Common_devices_DeviceUptimeWindowsType
object
Uptime windows for a single device.
2 properties
CrossingDirectionEnum
string
Camera_FindSharedVideoWallsWSRequest
object
Request to find shared video walls for a video wall.
1 property
Camera_GetMinimalCameraStateListWSResponse
object
Response containing a minimal list of camera states.
4 properties
Camera_GetCustomFootageSeekpointsV2WSResponse
object
Response containing custom footage seek points V2 for cameras.
4 properties
Camera_UpdateCameraAIThresholdsWSRequest
object
Request to update AI thresholds for a camera.
9 properties
Camera_GetMediaUrisWSResponse
object
Response containing media URIs for camera streaming and playback.
17 properties
Camera_GetMediaUrisWSRequest
object
Request to get media URIs for a camera device.
1 property
Camera_GetStorageRecoveryFileWSResponse
object
Response containing storage recovery file contents.
1 property
Common_devices_rawstream_LanSpecificRawStreamType
object
List of raw HTTP streams
14 properties
Camera_SharedLiveVideoStreamWS
object
List of shared live video streams for the doorbell camera
22 properties
Camera_UpdateConfigWSRequest
object
Request to update camera configuration settings.
1 property
Camera_CameraCurrentStateType
object
Current state information for a camera.
19 properties
Camera_DeleteSharedLiveVideoStreamWSRequest
object
Request to delete a shared live video stream.
2 properties
Camera_CreateSharedLiveVideoStreamWSResponse
object
Response containing the created shared live video stream information.
6 properties
Common_devices_rawstream_CreateRawHttpStreamWSResponse
object
Response containing raw HTTP stream URLs for a device.
6 properties
Camera_GetBatchRegistrationTokenUsageResponse
object
Response containing batch registration token usage information.
1 property
Camera_GetOfflineLanStreamingInfoWSResponse
object
Response containing offline LAN streaming information for cameras.
4 properties
WebResponseStatusEnum
string
Status of the unregister operation
CustomFootageSeekPointType
object
List of custom footage seek points to create
5 properties
2 required
MinimalDeviceStateType
object
List of minimal camera state information
34 properties
Camera_CreateSharedVideoWallWSResponse
object
Response containing the created shared video wall information.
5 properties
Camera_GenerateWifiChangeAuthorizationTokenWSRequest
object
Request to generate a WiFi change authorization token.
2 properties
Camera_UpdateCameraV2WSRequest
object
Request to update camera information V2 with partial update support.
27 properties
Common_devices_UpdateConfigWSResponse
object
Response indicating the result of updating device configuration.
3 properties
RegionOfInterest
object
Regions of interest that belong to the group. Group must have at least one region specified.
4 properties
ScopedCloudArchivingConfig
object
Cloud archiving configuration to update
6 properties
Camera_RebootCameraWSRequest
object
Request to reboot a camera device.
1 property
Camera_GetMinimalCameraLocationMapWSRequest
object
Request to retrieve a mapping of cameras to their location information.
Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig
object
Audio/video user configuration update
113 properties
Common_devices_rawstream_GetRawHttpStreamsWSRequest
object
Request to retrieve raw HTTP streams for a device.
1 property
FrontendEqualizerSettings
object
3 properties
RegionOfInterestGroupTypeEnum
string
Represents type of activity regions in the group. Defaults to 'Activity'.
DeviceHealthStatusDetailsEnum
string
Camera_CreateVideoWallWSResponse
object
Response from creating a video wall.
4 properties
RegionPolygonType
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Rhombus Systems publishes across the network.