1. Home / Web Services API Version 7.5 / GetDocuments

GetDocuments

Returns a list of documents and properties of the documents in the specified path.

Syntax

Visual Basic (declaration) 
Public Function GetDocuments( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal withpropertysets as bool, _ 
	ByVal withsecurity as bool, _ 
	ByVal withOwner as bool, _ 
	ByVal withVersions as bool) as XmlNode

C# (declaration) 
public XmlNode GetDocuments( 
	string AuthenticationTicket,
	string Path,
	bool withpropertysets,
	bool withsecurity,
	bool withOwner,
	bool withVersions)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string an infoRouter folder path
withpropertysets
    bool to get property sets with the results
withsecurity
    bool to get access list of the document with the results
withOwner
    bool to get owner information of the document with the results
withVersions
    bool to get version information of the document with the results

Return Value

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


<response success="true" error="">
  <document DocumentID="11937" Name="2007 graphics.JPG" Path="\Accounting\General Ledger" Description="czc" UpdateInstructions="" CreationDate="2007-12-27 13:10:12" ModificationDate="2007-12-27 13:43:29" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="86304" Type="Image" PercentComplete="0" CompletionDate="" Importance="0" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000001" />
  <document DocumentID="11930" Name="Annual operating budget 2007.xls" Path="\Accounting\General Ledger" Description="" UpdateInstructions="" CreationDate="2007-08-08 07:49:32" ModificationDate="2007-08-08 07:53:42" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="88576" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000001" />
  <document DocumentID="11931" Name="Asset Allocation Pie Chart 2006.xls" Path="\Accounting\General Ledger" Description="" UpdateInstructions="" CreationDate="2007-08-08 07:49:32" ModificationDate="2008-01-02 09:42:10" CheckoutDate="2008-01-02 09:42:16" CheckoutBy="System Administrator" CheckoutByUserName="sysadmin" Size="227328" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="10101" DocTypeName="Incoming Fax" VersionNumber="1000007" />
  <document DocumentID="11932" Name="Asset Allocation Pie Chart 2007.xls" Path="\Accounting\General Ledger" Description="" UpdateInstructions="" CreationDate="2007-08-08 07:49:33" ModificationDate="2007-08-08 07:49:33" CheckoutDate="2008-01-02 09:42:20" CheckoutBy="System Administrator" CheckoutByUserName="sysadmin" Size="231936" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000000" />
</response>

Remarks

The caller must have at least "List" permission on the folder.

See Also