1. Home / Web Services API Version 7.5 / GetDocumentsByPage

GetDocumentsByPage

Returns the page of documents in the specified path in short form.

Syntax

Visual Basic (declaration) 
Public Function GetDocumentsByPage( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal DocumentFilter as String, _ 
	ByVal PageNumber as  Integer) as XmlNode

C# (declaration) 
public XmlNode GetDocumentsByPage( 
	string AuthenticationTicket,
	string Path,
	string DocumentFilter,
	int PageNumber)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string an infoRouter folder path
DocumentFilter
    string filtering options like (*.doc)
PageNumber
    int Page Number that will be returned.

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="" folderid="10137" parentid="10124" name="General Ledger" path="\Accounting\General Ledger" documentfilter="*.xls" page="1" pageSize="20" itemcount="3">
  <d id="11930" n="Annual operating budget 2007.xls" mdate="2007-08-08 07:53:42" cdate="2007-08-08 07:49:32" size="88576" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000001" />
  <d id="11931" n="Asset Allocation Pie Chart 2006.xls" mdate="2008-01-02 09:42:10" cdate="2007-08-08 07:49:32" size="227328" dformat="Office Document" chkoutbyusername="sysadmin" chkoutbyfullname="System Administrator" version="1000007" />
  <d id="11932" n="Asset Allocation Pie Chart 2007.xls" mdate="2007-08-08 07:49:33" cdate="2007-08-08 07:49:33" size="231936" dformat="Office Document" chkoutbyusername="sysadmin" chkoutbyfullname="System Administrator" version="1000000" />
</response>

Remarks

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

See Also