SoftLayer Notification User Subscriber (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Notification_User_Subscriber data type. For information on the SoftLayer_Notification_User_Subscriber service please see SoftLayer_Notification_User_Subscriber.

Contents 1 Overview 2 Local Properties 2.1 active 2.2 id 2.3 notificationId 2.4 userRecordId 3 Relational Properties 3.1 deliveryMethods 3.2 notification 3.3 preferences 3.4 preferencesDetails 3.5 resourceRecord 3.6 userRecord 4 Count Properties 4.1 deliveryMethodCount 4.2 preferenceCount 4.3 preferencesDetailCount 5 Associated Methods

Overview

A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.

NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

active

The current status of the subscription.

• Type: integer
• Length: 1 digit

---

id

Unique identifier of the subscriber that will receive the alerts.

• Type: integer

---

notificationId

Unique identifier of the notification subscribed to.
notificationId is required for object creation.

• Type: integer
• Length: 10 digits

---

userRecordId

Unique identifier of the user the subscription is for.
userRecordId is required for object creation.

• Type: integer
• Length: 10 digits

Relational Properties

deliveryMethods

The delivery methods used to send the subscribed notification.
deliveryMethods can be queried by object mask.

• Type: SoftLayer_Notification_Delivery_MethodArray

---

notification

Notification subscribed to.
notification can be queried by object mask.
notification must be a unique value.

• Type: SoftLayer_Notification

---

preferences

Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

• Type: SoftLayer_Notification_User_Subscriber_PreferenceArray

---

preferencesDetails

Preference details such as description, minimum and maximum limits, default value and unit of measure.
preferencesDetails can be queried by object mask.

• Type: SoftLayer_Notification_PreferenceArray

---

resourceRecord

The subscriber id to resource id mapping.
resourceRecord can be queried by object mask.
resourceRecord must be a unique value.

• Type: SoftLayer_Notification_User_Subscriber_Resource

---

userRecord

User record for the subscription.
userRecord can be queried by object mask.
userRecord must be a unique value.

• Type: SoftLayer_User_Customer

Count Properties

deliveryMethodCount

A count of the delivery methods used to send the subscribed notification.
deliveryMethodCount must be a unique value.

• Type: unsigned long

---

preferenceCount

A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.
preferenceCount must be a unique value.

• Type: unsigned long

---

preferencesDetailCount

A count of preference details such as description, minimum and maximum limits, default value and unit of measure.
preferencesDetailCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Notification::getObject