EPT.GetCurrentTemplates Method (ConnectionId, SessionId, TemplateTypes, CategoryId)

EPTGetCurrentTemplates Method (ConnectionId, SessionId, TemplateTypes, CategoryId)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns a list of documents that are used as an template(s) of a category.

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

Syntax

public string GetCurrentTemplates(
	ConnectionId connectionId,
	SessionId sessionId,
	TemplateTypes templateType,
	CategoryId categoryId
)

Public Function GetCurrentTemplates ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	templateType As TemplateTypes,
	categoryId As CategoryId
) 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).
templateType: Type: ContentStudio.Document.EPTTemplateTypes
The type of template to list.
categoryId: Type: ContentStudio.DocumentCategoryId
The category to get the templates for.

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>

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the category is required to successfully execute this method.

Reference

EPT Class

GetCurrentTemplates Overload

ContentStudio.Document.EPT Namespace