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 Occupancy Webservice API

The Occupancy Webservice API from Rhombus Systems — 4 operation(s) for occupancy webservice.

Rhombus Systems Occupancy 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 Occupancy Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 16 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.

4 operations 4 paths 16 schemas 4 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 Occupancy 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 4

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

Occupancy Webservice 4
POST
/api/occupancy/getMinimalOccupancySensorStateList
Get minimal occupancy sensor state list
getMinimalOccupancySensorStateList 1 param body → 200
POST
/api/occupancy/getOccupancyEventsForSensor
Get occupancy events for sensor
getOccupancyEventsForSensor 1 param body → 200
POST
/api/occupancy/getOccupancyPresenceWindows
Get occupancy presence windows
getOccupancyPresenceWindows 1 param body → 200
POST
/api/occupancy/updateDetails
Update occupancy sensor details
updateOccupancySensorDetails 1 param body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Occupancysensor_UpdateOccupancySensorDetailsWSRequest (21 properties), Occupancysensor_MinimalOccupancySensorStateType (21 properties), OccupancyEventType (13 properties), Sensor_GetSensorPresenceWindowsWSResponse (4 properties). Each schema is shown below with its type and property counts.

Sensor_GetSensorPresenceWindowsWSResponse
object
Response object containing stored video information for a sensor.
4 properties
OccupancyStatusEnum
string
Current occupancy status of the sensor
Occupancysensor_MotionSensorHealthEnum
string
Motion sensor health status.
OccupancyEventType
object
List of occupancy events for the sensor
13 properties
Occupancysensor_MinimalOccupancySensorStateType
object
Minimal state information for occupancy sensors including health, location, and sensor data.
21 properties
Occupancysensor_UpdateOccupancySensorDetailsWSResponse
object
Response object for updating occupancy sensor details.
3 properties
Occupancysensor_GetOccupancyEventsForSensorWSResponse
object
Response object containing occupancy events for a specific sensor.
4 properties
Occupancysensor_UpdateOccupancySensorDetailsWSRequest
object
Request object for updating occupancy sensor details with selective update flags.
21 properties
OccupancyStateEnum
string
Occupancysensor_GetMinimalOccupancySensorStatesWSRequest
object
Request object for getting minimal occupancy sensor states for all sensors in organization.
TimeWindowSeconds
object
List of uptime windows for the device
2 properties
Sensor_GetSensorPresenceWindowsWSRequest
object
Request object for retrieving stored video information for a sensor.
3 properties
Occupancysensor_GetOccupancyEventsForSensorWSRequest
object
Request object for getting occupancy events for a specific sensor.
4 properties
HardwareVariationEnum
string
Occupancysensor_MotionSensorHealthDetailsEnum
string
Detailed motion sensor health status.
Occupancysensor_GetMinimalOccupancySensorStatesWSResponse
object
Response object containing minimal occupancy sensor states for all sensors in organization.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-occupancy-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 Occupancy 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.