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 the subscription definition given an address and address type.
This call can be used to return a list of all subscriptions for a specific subscriber (by her address).
Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetSubscriptionDefinitionByAddress( ConnectionId connectionId, SessionId sessionId, string address, SubscriberAddressType addressType )
Parameters
- connectionId
- Type: ContentStudioConnectionId
The connection id. - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - address
- Type: SystemString
The address. - addressType
- Type: ContentStudio.Document.SubscriptionSubscriberAddressType
Type of the address.
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"> <subscription subscriptionId="Guid string value" subscriberAddress="String value" subscriptionType="String value" subscriberAddressType="String value" subscriberName="String value" activated="Boolean string value" /> </definition> <!--more definition elements 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: indicates whether this subscription is enabled. |
| definition/@subscriptiontype | Integer: the integer representation of the type of subscription. |
| definition/subscription | This element represents the relevant subscription in the found definition. |
| definition/subscription/@subscriptionId | Guid: a global unique identifier of a single subscription. |
| definition/subscription/@subscriberAddress | String. The address of the subscription found. |
| definition/subscription/@subscriptionType | String. The type of subscription. The value is the string representation one of the members of the SubscriptionType enumeration. |
| definition/subscription/@subscriberAddressType | String. The type of address. The value is the string representation one of the members of the SubscriberAddressType enumeration. |
| definition/subscription/@subscriberName | String. The name of the subscriber of the subscription found. |
| definition/subscription/@activated | Boolean string; True or False. Defines whether this subscription is activated. |
Exceptions
| Exception | Condition |
|---|---|
| SqlException | An error occurred when executing the command against the Content Studio database |
| NotSupportedException | The value of the addressType is not supported. |
Content Studio permissions
See Also