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

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

Returns detailed information about a unit.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetItem(
	ConnectionId connectionId,
	SessionId sessionId,
	UnitId unitId
)

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).
unitId
Type: ContentStudio.DocumentUnitId
An identifier to to the unit to get details for

Return Value

Type: String

XML returned for a user that has READ CONTAINER permission on the unit

Copy
<root>
    <status>0</status>
    <statustext>OK</statustext>
    <cs_unit>
        <unitid>Integer value</unitid>
        <unitname>String value</unitname>
        <!-- Optional elements -->
        <telnr>String value</telnr>
        <adress>String value</adress>
        <faxnr>String value</faxnr>
        <email>String value</email>
        <zipcode>String value</zipcode>
        <city>String value</city>
        <!-- end of optional elements -->
        <metadata>String value</metadata>
        <statusint>String value</statusint>
        <statustext>String value</statustext>
        <islocal>Bit value</islocal>
        <isglobal>Bit value</isglobal>
        <startid>Integer value</startid>
        <treeid>Integer value</treeid>
        <ownerid>Integer value</ownerid>
        <owner>String value</owner>
        <description>String value</description>        
        <GUOID>String value</GUOID>        
    </cs_unit>
</root>

XML returned for a user that lacks READ CONTAINER permission on the unit

Copy
<root>
    <status>0</status>
    <statustext>OK</statustext>
    <cs_unit>
        <unitid>Integer value</unitid>
        <unitname>String value</unitname>
        <!-- Optional elements -->
        <email>String value</email>
        <!-- end of optional elements -->
        <startid>Integer value</startid>
        <treeid>Integer value</treeid>
        <description>String value</description>        
        <GUOID>String value</GUOID>        
    </cs_unit>
</root>
Exceptions
ExceptionCondition
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
Any authenticated user can call this method. However if the caller does not have the READ_CONTAINER permission or the GLOBAL_GROUP_ADMIN right only a subset of the list is returned.
See Also

Reference

UnitReader Class
GetItem Overload
ContentStudio.Document Namespace