1. Home / Web Services API Version 7.5 / GetDocument

GetDocument

Returns the properties of the document in the specified path.

Syntax

Visual Basic (declaration) 
Public Function GetDocument( _ 
	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 GetDocument( 
	string AuthenticationTicket,
	string Path,
	bool withPropertySets,
	bool withSecurity,
	bool withOwner,
	bool withVersions)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string Path of the document
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 properties has been returned successfully.
if success attribute is "false", the error attribute indicates the encountered
error.
The sub nodes of the response element indicates properties

<response success="true" error="">
  <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">
    <User exists="true" Domain="" UserName="sysadmin" FirstName="System" LastName="Administrator" Email="sysadmin@infoRouter.com" LastLogonDate="2007-04-11 11:10:00" LastPasswordChangeDate="2007-07-12 11:55:40" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE">
      <Preferences>
        <Language>en</Language>
        <DefaultPortal>
        </DefaultPortal>
        <ShowArchives>TRUE</ShowArchives>
        <ShowHiddens>TRUE</ShowHiddens>
        <NotificationType>INSTANT</NotificationType>
        <EmailType>HTML</EmailType>
        <AttachDocumentToEmail>TRUE</AttachDocumentToEmail>
      </Preferences>
    </User>
    <Propertysets />
    <AccessList DateApplied="2007-12-27 13:04:49" AppliedBy="System Administrator" InheritedSecurity="false">
      <UserGroup DomainName="" GroupName="Accountants" Right="2" Description="(Read)" />
      <UserGroup DomainName="" GroupName="Auditors" Right="2" Description="(Read)" />
      <User DomainName="" UserName="adamb" Right="6" Description="(Full Control)" />
      <User DomainName="" UserName="diannaf" Right="6" Description="(Full Control)" />
      <User DomainName="" UserName="michaely" Right="6" Description="(Full Control)" />
    </AccessList>
    <Versions>
      <Version Number="1000001">
        <Publisher>System Administrator</Publisher>
        <VersionSize>88576</VersionSize>
        <CheckSum>970A094B</CheckSum>
        <DatePublished>2007-08-08 07:53:42</DatePublished>
        <Comment>
        </Comment>
      </Version>
      <Version Number="1000000">
        <Publisher>System Administrator</Publisher>
        <VersionSize>94720</VersionSize>
        <CheckSum>EA4136FC</CheckSum>
        <DatePublished>2007-08-08 07:49:32</DatePublished>
        <Comment>
        </Comment>
      </Version>
    </Versions>
  </document>
</response>

Remarks

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

See Also