Alarm Monitoring Keypad Webservice

Claim keypad activation token

Connects a keypad to Rhombus services

post/api/keypad/claimKeypadActivationToken

Request

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

activationTokenstring nullable

Activation token for claiming the keypad

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

namestring nullable

Name for the keypad

subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

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

Example request

{
  "activationToken": "act_token_12345",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Main Entrance Keypad",
  "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.