EPT.GetAvaliableTemplates Method (ConnectionId, SessionId, String, Int32, String)

EPTGetAvaliableTemplates Method (ConnectionId, SessionId, String, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns a list of EPT-template documents that can be used with a certain category for a certain user. The method can return templates filtered by category, unit or all templates.

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

Syntax

Copy

public string GetAvaliableTemplates(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

Public Function GetAvaliableTemplates ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

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).
xmlParameterData: Type: SystemString
A string that contains the parameters to use
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Return Value

Type: String
XML

Copy

<root>
    <status>0</status>
    <statustext>Success</statustext>
    <templates>
        <template>
            <id>Integer value</id>
            <categoryid>Integer value</categoryid>
            <unitid>Integer value</unitid>
            <name>String value</name>
            <owner>String value</owner>
            <unitname>String value</unitname>
            <categoryname>String value</categoryname>
        </template>
        <!-- more template elements can follow-->
    </templates>
</root>

Content Studio permissions

All authenticated users can successfully execute this method.

Remarks

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

Reference

EPT Class

GetAvaliableTemplates Overload

ContentStudio.Document.EPT Namespace