DocumentReaderGetDocumentFromRelativeURL Method (ConnectionId, SessionId, 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.

Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).

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

[ObsoleteAttribute("This method is obsolete, use the GetDocumentIdentifierFromRelativeURL method, which is easier to use.")]
public string GetDocumentFromRelativeURL(
	ConnectionId connectionId,
	SessionId sessionId,
	string documentPath
)

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).
documentPath
Type: SystemString
The document's relative url.

Return Value

Type: String
XML
<root>
 <status>0</status>
 <statustext>Success</statustext>
 <document id="Integer value"/>
</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

BROWSE permission on the document is required. This method supports anonymous calls
Remarks

This method is obsolete. An identical method, GetDocumentIdentifierFromRelativeURL(ConnectionId, SessionId, String) should be used instead. The difference between the two methods is that this method returns an Xml document instead of an integer.
See Also

Reference