1. Home / Web Services API Version 8.x / GetMyDocumentsAndFolders

GetMyDocumentsAndFolders

Returns list of documents and folders owned by the current user.

Syntax

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

C# (declaration) 
public XmlNode GetMyDocumentsAndFolders( 
	string AuthenticationTicket,
	bool withrules,
	bool withpropertysets,
	bool withsecurity,
	bool withOwner,
	bool withVersions)

Parameters

AuthenticationTicket
    string infoRouter ticket
withrules
    bool to get folder rules with the results
withpropertysets
    bool to get property sets with the results
withsecurity
    bool to get access list with the results
withOwner
    bool to get owner information of the folder with the results
withVersions
    bool to get version information of the documents with the results

Return Value

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

<response success="true" error="">
  <folder FolderID="10124" Name="Accounting" Path="\Accounting" Description="This library stores accounting related documents. It is restricted to authorized users." CreationDate="2007-06-14 10:54:53" OwnerName="System Administrator" />
  <folder FolderID="10125" Name="Annoucements" Path="\Annoucements" Description="This library stores annoucements and it is open to read access by all. Only authorized users can publish announcements." CreationDate="2007-06-14 10:55:08" OwnerName="System Administrator" />
	...
  <document DocumentID="11599" Name="11073.pdf" Path="\View Types\Workflow View" Description="Description" UpdateInstructions="" CreationDate="2007-06-14 00:00:00" ModificationDate="2007-06-14 00:00:00" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="33023" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="0" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11936" Name="2004 year end financials mag tape.htm" Path="\Physical Document Tracking" Description="" UpdateInstructions="" CreationDate="2007-08-08 09:27:56" ModificationDate="2007-08-08 09:27:56" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="5308" Type="Internet Document" PercentComplete="0" CompletionDate="" Importance="0" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000000" />
	...
</response>

See Also