Register a Rhombus reader that a Door Controller has discovered

Register a Rhombus reader that a Door Controller has discovered

POST /api/doorcontroller/registerDiscoveredRhombusReader

Register a Rhombus reader that a Door Controller has discovered

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/doorcontroller/registerDiscoveredRhombusReader \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "boardNum": 1,
  "doorControllerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "portNum": 0,
  "serialNumber": "RR-12345678"
}
'

200

{}

Authorizations

x-auth-apikey · string · header · required

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

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

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

Body

application/json

Request object for registering a Rhombus reader discovered by a door controller.

boardNum · integer<int32> | null

Board number for the reader connection

Example:

1

doorControllerUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

portNum · integer<int32> | null

Port number for the reader connection

Example:

0

serialNumber · string | null

Serial number of the discovered Rhombus reader

Example:

"RR-12345678"

Response

200 - application/json

OK

Response object for registering a Rhombus reader discovered by a door controller.