Create pending registration

Create a pending registration. Registration will be completed when the hardware establishes connectivity

POST /api/org/createPendingRegistration

Create pending registration

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/org/createPendingRegistration \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "serialNumber": "RH123456789",
  "wifiPsk": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "wifiSsid": "Office_WiFi"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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 creating pending hardware registration.

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

orgUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

serialNumber · string | null

Serial number of the hardware device

Example:

"RH123456789"

wifiPsk · (string<byte> | null)[] | null

WiFi pre-shared key for the device

WiFi pre-shared key for the device

wifiSsid · string | null

WiFi SSID for the device

Example:

"Office_WiFi"

Response

200 - application/json

OK

Response object for creating pending hardware registration.

error · boolean | null

errorMsg · string | null

warningMsg · string | null