Button Webservice

Update button details

Update details for a button sensor.

post/api/button/updateDetails

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/button/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 UUIDs

buttonMode'PANIC' | 'PROGRAMMABLE' | 'DOORBELL' | 'NONE'

Optional button mode configuration

descriptionstring nullable

Optional description for the button sensor

floorNumberinteger nullable

Optional floor number

latitudenumber double nullable

Optional latitude coordinate

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

longitudenumber double nullable

Optional longitude coordinate

namestring nullable

Optional name for the button sensor

sensorUuidstring RUUID nullable

base 64 (url-safe) uuid string

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 has been updated

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "floorNumber": 1,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.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.