Skip to main content
POST
/
api
/
customer
/
getUserSnoozedNotificationSettings
Get the current and planned user notification snooze details
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 '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "snoozedForAllNotificationsIntervals": [
    {
      "durationSecs": 123,
      "timestampSec": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "snoozedForComponentCompositesMap": {},
  "snoozedForDevicesMap": {},
  "snoozedForLocationsMap": {},
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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

snoozedForComponentCompositesMap
object

Map of component composite UUIDs to their snooze notification intervals

snoozedForDevicesMap
object

Map of device UUIDs to their snooze notification intervals

snoozedForLocationsMap
object

Map of location UUIDs to their snooze notification intervals

warningMsg
string | null