Occupancy Webservice

Update occupancy sensor details

Update the details of an occupancy sensor

post/api/occupancy/updateDetails

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/occupancy/updateDetails
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

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.

Request body

associatedCamerasstring[] nullable

List of associated camera device facet UUIDs

associatedCamerasUpdatedboolean nullable

Whether the associated cameras should be updated

deletedboolean nullable

Whether the sensor is marked as deleted

deletedUpdatedboolean nullable

Whether the deleted status should be updated

descriptionstring nullable

Description of the occupancy sensor

descriptionUpdatedboolean nullable

Whether the description should be updated

floorNumberinteger nullable

Floor number where the sensor is located

floorNumberUpdatedboolean nullable

Whether the floor number should be updated

latitudenumber double nullable

Latitude coordinate of the sensor location

latitudeUpdatedboolean nullable

Whether the latitude should be updated

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationUuidUpdatedboolean nullable

Whether the location UUID should be updated

longitudenumber double nullable

Longitude coordinate of the sensor location

longitudeUpdatedboolean nullable

Whether the longitude should be updated

namestring nullable

Name of the occupancy sensor

nameUpdatedboolean nullable

Whether the name should be updated

policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyUuidUpdatedboolean nullable

Whether the policy UUID should be updated

subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

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

subLocationsHierarchyKeyUpdatedboolean nullable

Whether the sub-locations hierarchy key should be updated

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "description": "Motion sensor for conference room A",
  "floorNumber": 2,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "Conference Room Sensor",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.