UserPropertiesGetProperty Method (ConnectionId, SessionId, String, TrusteeUserIdentifiers, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Note: This API is now obsolete.

Gets a custom Content Studio User property.

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

[ObsoleteAttribute("The GetProperty method is obsolete, consider using the GetApplicationProperties method instead")]
public string GetProperty(
	ConnectionId connectionId,
	SessionId sessionId,
	string identifier,
	TrusteeUserIdentifiers idType,
	string propertyName
)

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).
identifier
Type: SystemString
An identifier to a user.
idType
Type: ContentStudio.SecurityTrusteeUserIdentifiers
The type of identifier entered in the Identifier parameter.
propertyName
Type: SystemString
The name of the property to get. The property must have the form Application.Property. For the system application a single dot (.) can be used. The following system property name are defined
  • email
  • title
  • office
  • address
  • zip
  • city
  • country
  • phone
  • cellphone
  • fax
  • company
  • homephone
  • startdoc (the user's start page in Content Studio)
  • infodoc (the user's personal page in Content Studio)
  • webviewbool (indicates whether to display the tree view in Content Studio or not)
  • pflang (indicates the user's preferred language setting)

Return Value

Type: String
Xml in the format:
<root>
 <status>0</status>
 <statustext>Success</statustext>
 <value>Property value</value>
</root>
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database. The following numbered exceptions are common:
  • 1001 - The session is invalid
  • 1002 - Permission denied
  • 1023 - The property does not exist
  • 1024 - The application does not exist
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

A user can always work with her own data. For other accounts the caller must have the GlobalGroupAdmin user right.
Remarks

All property an application names are case sensitive.
The GetApplicationProperties(ConnectionId, SessionId, String, TrusteeUserIdentifiers, String) method performs the same operations as GetProperty method but is much simpler and more efficient.
See Also

Reference