Get the current and planned user notification snooze details

Get the current and planned user notification snooze details

POST /api/customer/getUserSnoozedNotificationSettings

Get the current and planned user notification snooze details

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/customer/getUserSnoozedNotificationSettings \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "snoozedForAllNotificationsIntervals": [
    {
      "durationSecs": 123,
      "timestampSec": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "snoozedForComponentCompositesMap": {},
  "snoozedForDevicesMap": {},
  "snoozedForLocationsMap": {},
  "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 retrieving current and planned user notification snooze details.

Response

200 - application/json

OK

Response object containing current and planned user notification snooze details.

error · boolean | null

errorMsg · string | null

snoozedForAllNotificationsIntervals · object[] | null

List of intervals when all notifications are snoozed

Show child attributes

snoozedForComponentCompositesMap · object

Map of component composite UUIDs to their snooze notification intervals

Show child attributes

snoozedForDevicesMap · object

Map of device UUIDs to their snooze notification intervals

Show child attributes

snoozedForLocationsMap · object

Map of location UUIDs to their snooze notification intervals

Show child attributes

warningMsg · string | null