Org Webservice

Create pending registration

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

post/api/org/createPendingRegistration

Request

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

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

orgUuidstring RUUID nullable required

base 64 (url-safe) uuid string

serialNumberstring nullable required

Serial number of the hardware device

wifiPskstring[] nullable

WiFi pre-shared key for the device

wifiSsidstring nullable

WiFi SSID for the device

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "serialNumber": "RH123456789",
  "wifiSsid": "Office_WiFi"
}

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.