CategoryReaderGetCategoriesByIdList Method (ConnectionId, SessionId, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Reads category information for a list of categories where the caller has CREATE permission.

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

public string GetCategoriesByIdList(
	ConnectionId connectionId,
	SessionId sessionId,
	int[] categoryIdList
)

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).
categoryIdList
Type: SystemInt32
A list of category id:s to return data for.

Return Value

Type: String
<para>
                Xml with the following syntax,
            </para>
            <root>
                <status>Integer value</status>
                <statustext>String value</statustext>
                <categories>
                    <category id="Integer value"
                              name="String value"
                              description="String value"
                              module="String value"
                    />
                    <!-- more category elements can follow -->
                </categories>
            </root>

The returned xml has the following elements and attributes

id
ElementAttributeDescription
root/statusInteger: Indicates the outcome of the call, always 0, which indicates success.
root/statustextString: Indicates the outcome of the call, always 0, which indicates success.
root/categoriesThe root element of the returned category list
root/categories/categoryThe root element of a returned category, this element occur once for each returned category.
root/categories/categoryInteger: the category identifier
root/categories/categorynameString: the name of the category
root/categories/categorydescriptionString: the description of the category
root/categories/categorymodule

String: An internal value that defines the type of category.
The table below lists the supported value for ModuleName.

Supported values for ModuleName
ModuleNameDescription.
ActiveScriptingThe category contains AS-components.
DokumentThe category contains regular documents, with or without meta data.
EditTemplateThe category contains Editing templates.
FilThe category contains uploaded files
FormatmallThe category contains templates (for fragments of a page).
HelsidesmallThe category contains document templates.
PresentationTemplateThe category contains presentation templates.
XMLDocumentThe category contains EPT documents.
Content Studio permissions

CREATE permission on the object is required or GlobalGroupAdmin global right.
See Also

Reference