EPT.GetAvaliableTemplates Method (ConnectionId, SessionId, TemplateTypes, CategoryId, CategoryId, UnitId)

EPTGetAvaliableTemplates Method (ConnectionId, SessionId, TemplateTypes, CategoryId, CategoryId, UnitId)

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,
	TemplateTypes templateType,
	CategoryId currentCategoryId,
	CategoryId categoryId,
	UnitId unitId
)

Public Function GetAvaliableTemplates ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	templateType As TemplateTypes,
	currentCategoryId As CategoryId,
	categoryId As CategoryId,
	unitId As UnitId
) 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
One of the TemplateTypes to list.
currentCategoryId: Type: ContentStudio.DocumentCategoryId
The category to read template information from.
categoryId: Type: ContentStudio.DocumentCategoryId
The category to list from. Pass zero to list from all categories
unitId: Type: ContentStudio.DocumentUnitId
The unit to list from. Pass zero to list from all units

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

All authenticated users can successfully execute this method.

Reference

EPT Class

GetAvaliableTemplates Overload

ContentStudio.Document.EPT Namespace