Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
This method can only successfully be executed
by sessions that have the ServiceQueueAdmin global right
or have READ permission on the category.
[This is preliminary documentation and is subject to change.]
Gets a subscriptions item.
Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string SubscriptionItem( ConnectionId connectionId, SessionId sessionId, Guid subscriptionId )
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). - subscriptionId
- Type: SystemGuid
A identifier of the subscription to get.
Return Value
Type: StringXml with the following syntax
<root> <status>0</status> <statustext>Success</statustext> <subscriptions> <subscription 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 value (True or False)"/> </subscriptions> <subscriptionDefinitionId>Guid string value </subscriptionDefinitionId> <subscriptionType>String value </subscriptionType> </root>
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | The session is invalid |
ArgumentException | The specified subscriptionId does not exist. |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
Note |
---|
This method is new in Content Studio 5.2 |
See Also