NativeSubscriptionManagerGetSubscribers Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a pageable list of subscribers connected to a subscription definition.

Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetSubscribers(
	ConnectionId connectionId,
	SessionId sessionId,
	Guid subscriptionDefinitionId,
	SubscriptionSorting sortOrder,
	bool noDataOnDeactivated,
	int pageSize,
	int pageNumber


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemGuid
A Guid that uniquely identifies the subscription definition that contains the meta data about the subscription.
Type: ContentStudio.Document.SubscriptionSubscriptionSorting
A value that defines how the returned data is sorted.
Type: SystemBoolean
Indicates whether any subscribers should be returned if the subscription definition is disabled. If noDataOnDeactivated is true also inactivated subscriptions are omitted as well.
Type: SystemInt32
The size of the returned data page. This value can be zero to return all records in a single page but cannot be negative.
Type: SystemInt32
The ordinal number of data page to return. This value is one-based and cannot be negative, zero is allowed but returns no subscribers.

Return Value

Type: String

Xml with the following syntax

      <subscription recordNumber="Integer value"
                    subscriptionId="String value"
                    subscriberAddress="String value"
                    subscriberAddressType="String value"
                    subscriberName="String value"
                    externalMembershipProviderName="String value"
                    externalSubscriberIdentifier="String (object) value"
                    subscriptionDate="DateTime value"
                    categoryId="Integer value"
                    categoryName="String value"
                    description="String value"
                    activated="Boolean string value (True or False)" />
      <!-- more subscription elements can follow -->
  <subscriptionDefinitionId>String value</subscriptionDefinitionId>
  <enabled>Boolean value</enabled>
  <pagesize>Integer value</pagesize>
  <pagenumber>Integer value</pagenumber>
  <pagecount>Integer value</pagecount>
  <recordcount>Integer value</recordcount>

The xml elements and attributes have the following meaning.

statusInteger: the outcome of the call, always 0 indicating success
statustextString: the textual representation of the outcome of the call, always "Success".
subscriptionsThe root node for the list of found subscriptions.
subscriptionThis empty element represents an existing subscription.
subscription@recordNumberInteger: A value that returns the overall ordinal number of a record. The first record of each page is 1 + (pageSize * (pageNumber - 1)).
subscription@subscriptionIdString: A Guid that uniquely identifies an individual subscription.
subscription@subscriberAddressString: The address of the subscriber. This can be an email address or a custom formatted address.
subscription@subscriberAddressTypeInteger. This value is reserved for future use.
subscription@subscriberNameString: The name of the subscriber
subscription@externalMembershipProviderNameString: The name of the MembershipProvider that stores the subscribers details. This attribute can be missing.
subscription@externalSubscriberIdentifierIdentifier (Object): The identifier of the subscriber in the MembershipProvider. This attribute can be missing.
subscription@subscriptionDate DateTime string that indicates when the subscription was made. This value is according to the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the database server when the subscription was made.
subscription@categoryIdInteger: The identifier of the category.
subscription@categoryNameString: The name of the category.
subscription@descriptionString: The description of the category.
subscription@activatedBoolean string: true if the subscription is activated, otherwise, false.
subscriptionDefinitionIdString: A Guid that uniquely identifies the subscription definition that contains the meta data about the subscription.
enabledBoolean string: true if the subscription definition is enabled, otherwise, false.
pagesizeInteger: The requested data size. This value is the same as the pageSize input parameter.
pagenumberInteger: The one-based ordinal number of the data page returned. This value is the same as the pageNumber input parameter.
pagecountInteger: The total number of data pages that exists
recordcountInteger: The total number of found subscriptions on the category

CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
ArgumentOutOfRangeException Either pageSize or pageNumber was negative. - or - the sortOrder parameter is invalid.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

This method can only successfully be executed by sessions that have the ServiceQueueAdmin global right or have READ permission on the category.

Note Note
This method is new in Content Studio 5.2
See Also