Occupancy

Get minimal occupancy sensor state list

Get basic state information about all proximity tags in organization

POST/api/occupancy/getMinimalOccupancySensorStateList

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting minimal occupancy sensor states for all sensors in organization.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "occupancySensorStates": [
    {
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "batteryPercent": 85,
      "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
      "firmwareVersion": "1.2.3",
      "floorNumber": 2,
      "health": "GREEN",
      "healthDetails": "NONE",
      "hwVariation": "RASPBERRY_PI_3",
      "lastSeenSec": 1640995200,
      "latitude": 37.7749,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Conference Room Sensor",
      "normalizedLux": 0.75,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rawLux": 500,
      "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "serialNumber": "RH123456789",
      "signalStrength": -45,
      "status": "VACANT",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Response

200 OK

application/json · object

Response object containing minimal occupancy sensor states for all sensors in organization.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

occupancySensorStatesobject[] | null

List of minimal occupancy sensor states

Show child attributes

associatedCamerasstring<DeviceFacetUuid>[] | null

List of associated camera device facet UUIDs

batteryPercentinteger<int32> | null

Battery percentage of the sensor

Example: 85

closestBaseStationstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

firmwareVersionstring | null

Firmware version of the sensor

Example: "1.2.3"

floorNumberinteger<int32> | null

Floor number where the sensor is located

Example: 2

healthenum<string>

Motion sensor health status.

Available options: RED, GREEN

healthDetailsenum<string>

Detailed motion sensor health status.

Available options: NO_HEARTBEAT, FIRMWARE_BEHIND, NONE

hwVariationenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

lastSeenSecinteger<int64> | null

Timestamp when the sensor was last seen (seconds since epoch)

Example: 1640995200

latitudenumber<double> | null

Latitude coordinate of the sensor location

Example: 37.7749

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | null

Longitude coordinate of the sensor location

Example: -122.4194

namestring | null

Name of the occupancy sensor

Example: "Conference Room Sensor"

normalizedLuxnumber<float> | null

Normalized lux value (0-1) matching human perception of lighting transitions

Example: 0.75

policyUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rawLuxinteger<int32> | null

Raw lux value from the sensor

Example: 500

sensorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serialNumberstring | null

Serial number of the occupancy sensor

Example: "RH123456789"

signalStrengthinteger<int32> | null

Signal strength of the sensor

Example: -45

statusenum<string>

Current occupancy status of the sensor

Available options: VACANT, MOVEMENT, OCCUPIED

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.