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

GetCheckedoutDocuments

Returns list of checked out documents by the current user.

Syntax

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

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

Parameters

AuthenticationTicket
    string infoRouter ticket
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.
if success attribute is "false", the error attribute indicates the encountered error. 

<response success="true" error="">
  <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>

See Also