Customer Webservice

Get the current and planned user notification snooze details

Get the current and planned user notification snooze details

post/api/customer/getUserSnoozedNotificationSettings

Request

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

CustomerGetUserSnoozedNotificationSettingsWSRequest required

Request object for retrieving current and planned user notification snooze details.

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
snoozedForComponentCompositesMapobject nullable

Map of component composite UUIDs to their snooze notification intervals

snoozedForDevicesMapobject nullable

Map of device UUIDs to their snooze notification intervals

snoozedForLocationsMapobject nullable

Map of location UUIDs to their snooze notification intervals

warningMsgstring nullable

Example response

{
  "snoozedForAllNotificationsIntervals": [
    {
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.