Alarm Monitoring Keypad Webservice

Update keypad

Update keypad settings

post/api/keypad/updateKeypad

Request

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

additionalFeaturesDisabledboolean nullable
armCountdownSecsinteger nullable

Arm countdown seconds for the keypad

buildingAdminPhoneNumberstring nullable

Phone number of the building administrator

floorNumberinteger nullable

Floor number where the keypad is located

keypadUuidstring RUUID nullable

base 64 (url-safe) uuid string

latitudenumber double nullable

Latitude coordinate of the keypad location

locationNamestring nullable

Name of the location where the keypad is installed

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

logoUuidstring RUUID nullable

base 64 (url-safe) uuid string

longitudenumber double nullable

Longitude coordinate of the keypad location

namestring nullable

Name of the keypad

showCallBuildingAdminboolean nullable

Whether to show the call building admin option

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

timeZoneIdstring nullable

Time zone ID for the keypad location

videoWallUuidstring RUUID nullable

base 64 (url-safe) uuid string

videoWallUuidUpdatedboolean nullable

Whether the video wall UUID has been updated

Example request

{
  "armCountdownSecs": 30,
  "buildingAdminPhoneNumber": "+1-555-123-4567",
  "floorNumber": 1,
  "keypadUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "latitude": 37.7749,
  "locationName": "Main Building",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "logoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "Main Entrance Keypad",
  "showCallBuildingAdmin": true,
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "timeZoneId": "America/Los_Angeles",
  "videoWallUuid": "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.