GUOID.LookupID Method (ConnectionId, SessionId, String, Int32, String)

GUOIDLookupID Method (ConnectionId, SessionId, String, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Transforms a list of id:s of the Unit, Category or Document type to a list of GUOID of objects. The list items must be separated by a pipe (|). This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

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

Syntax

Copy

public string LookupID(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlData,
	out int status,
	out string statusText
)

Public Function LookupID ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) 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).
xmlData: Type: SystemString
A xml document that contains input parameters.
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Return Value

Type: String
XML

Content Studio permissions

All users with a valid session can execute this method. Anonymous access is not supported.

Remarks

The returned data is an XML document where each row has the format <object id="17" guoid="OK00000000G0000G0000GFACAG000000000017" class="D" filename="System/AS_Document/44EF10BD-E32D-49E2-9740-75A07BD71197.aspx"/> depending on the data returned. The procedure omits duplicate id:s but returns an empty string in the GUOID field for id:s that does not exists in the system. If an item in the list is non numerical it will be omitted as well. Status returns 0 Success 1001 Invalid Session 1009 Invalid parameter value 1106 Invalid object type. ************* XML input <root> <parameters> <parameter name="objectType">D</parameter> <parameter name="list">1|2|3|4|5|6|7</parameter> </parameters> </root> ************ Return XML <root> <list> <object id="1" guoid="OK00000000G0000G0000GFACAG000000000001" class="D" filename="System/AS_Date/FC645263-FD5C-494C-B969-1F8E1E8952CC.aspx"/> <object id="2" guoid="OK00000000G0000G0000GFACAG000000000002" class="D" filename="System/AS_Document/44EF10BD-E32D-49E2-9740-75A07BD71197.aspx"/>  </list> </root>

Reference

GUOID Class

LookupID Overload

ContentStudio.Document Namespace