CategoryReaderGetCategoryList Method (ConnectionId, SessionId, UnitId, FolderReaderFolderSortOrder) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns a list of categories within a unit. Subcontainers below the first level are excluded.

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

public string GetCategoryList(
	ConnectionId connectionId,
	SessionId sessionId,
	UnitId unitId,
	FolderReaderFolderSortOrder sortOrder


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: ContentStudio.DocumentUnitId
An identifier to a unit whose child categories should be listed.
Type: ContentStudio.DocumentFolderReaderFolderSortOrder
One of the FolderReaderFolderSortOrder enumeration values that specifies how the list is sorted.

Return Value

Type: String
XML containing a list of categories.
    <status>Integer value</status>
    <statustext>String value</statustext>
    <recordcount>Integer value</recordcount>
    <parentid>Integer value</parentid>
    <module>String value</module>
    <location>String value</location>
    <customviewurl>String value</customviewurl>
    <documenttype>Integer value</documenttype>
    <documentfilenamingconvention>Integer value</documentfilenamingconvention>
            <id>Integer value</id>
            <name>String value</name>
            <type>String value</type>
            <module>String value</module>
            <description>String value</description>
            <hasdirectace>Bit value</hasdirectace>
            <documenttype>String value</documenttype>
            <documentfilenamingconvention>Integer value</documentfilenamingconvention>
            <filepath>Integer value</filepath>
        <!-- more category element can follow -->

The elements have the following meaning

Xml description
root/statusInteger: Indicates the outcome of the call, always 0 which indicates success
root/statustextString: The textual representation of the status, always OK
root/recordcountInteger: The number of records returned.
root/parentidInteger: The identifier of the parent of the container specified in unitId.
root/moduleString: Always 'Unit'.
root/location The relative path name to the unit referenced by unitId (e.g. MyUnit). This relative path is the path in the underlying file system.
root/customviewurlAlways Empty
root/documenttypeAlways Empty
root/documentfilenamingconventionAlways Empty
root/categoriesRoot element for the list of categories
root/categories/categoryRoot element for a single found category. This element occurs once per found category.
root/categories/category/idInteger: The identifier of the category.
root/categories/category/nameString: The name of the category.
root/categories/category/typeThe type of container. This value is always 'C'
root/categories/category/moduleString: A value that indicates the type of category. This value cannot fully be used to determine the type of a category. Use the GetDocumentType(ConnectionId, SessionId, CategoryId) method or the root/categories/documenttype element value to determine the type of document a category can contain.
root/categories/category/descriptionString: A description of the category.
root/categories/category/hasdirectaceBit: A value that indicates whether the category has any direct ACE (Access control entry)
root/categories/documenttype The type of document that the category listed can contain. The value of this element is the numeric value of a member of the DocumentTypes enumeration.
root/categories/documentfilenamingconventionA value that indicates how Content Studio determines the name of documents created in the category listed. The value of this element is the numeric value of a member of the FolderBaseDocumentFileNamingConvention enumeration.
root/categories/category/filepath The relative path name to the category.

This relative path is the path in the underlying file system which means that some of the special system folders are different from the path shown in Content Studio.

These are i version 5.1: Special category mappings
IdFolderMaps to

CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

READ permission on the category is required. CS 5.6 and later; Anonymous access supported
See Also