1. Home / Web Services API Version 7.5 / GetDocumentAbstract

GetDocumentAbstract

Returns the abstract of the document in the specified path if available

Syntax

Visual Basic (declaration) 
Public Function GetDocumentAbstract( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal VersionNumber as  Integer) as XmlNode

C# (declaration) 
public XmlNode GetDocumentAbstract( 
	string AuthenticationTicket,
	string Path,
	int VersionNumber)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string Path of the document
VersionNumber
    int Version Number of the document.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the document properties has been returned successfully.
if success attribute is "false", the error attribute indicates the encountered
error.

Remarks

The caller must have at least "Read" permissions on the document or must be the owner of the document.
Index server must be enabled.

See Also