Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Return Xml syntax
Any authenticated or anonymous user can successfully call this method.
[This is preliminary documentation and is subject to change.]
Gets a list of all categories that users can subscribe to.
Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetSubscribableCategories( ConnectionId connectionId, SessionId sessionId, SubscriptionType subscriptionType )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - subscriptionType
- Type: ContentStudio.Document.SubscriptionSubscriptionType
The type of the subscription to list. Currently only Newsletter is valid.
Return Value
Type: StringXml with the following syntax:
<root> <status>0</status> <statustext>Success</statustext> <definition identifier="Guid string value" categoryid="Integer value" name="String value" description="String value" enabled="Bit value" subscriptiontype="Integer value" /> <!--more definition can follow --> </root>
This Xml has the following elements and attributes
Element/Attribute | Description |
---|---|
status | Integer: The outcome of the call, always 0 |
statustext | String: the textual outcome of the call, Always "Success" |
definition | This element represents a found category |
definition/@identifier | Guid: a global unique identifier of this data. This value can be used by external applications to connect a subscriber repository to a category |
definition/@categoryid | Integer: the Content Studio identifier of this category |
definition/@name | String: the name of the category |
definition/@description | String: a description of the category. |
definition/@enabled | Bit: 1 or 0. |
definition/@subscriptiontype | Integer: the integer representation of the type of subscription. |
Exceptions
Exception | Condition |
---|---|
SqlException | An error occurred when executing the command against the Content Studio database |
NotSupportedException | The value of the subscriptionType is not supported. |
Content Studio permissions
Remarks
Note |
---|
This method is new in Content Studio version 5.2 |
See Also