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

GetFoldersAndDocumentsByPage

Returns the first page (1 to 20) of documents and folders in the specified path.

Syntax

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

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

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string an infoRouter folder path
FolderFilter
    string filtering options for documents
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 folders and documents have been returned successfully like the sample below.
if success attribute is "false", the error attribute indicates the encountered error.

    <response success="true" error="" folderid="1000" parentid="0" name="Corporate" path="\Corporate" folderfilter="" documentfilter="" page="1" pageSize="20" itemcount="26">
        <f id="1011" n="Abc Corp."/>
        <f id="1017" n="Noises"/>
        <f id="1016" n="Mac"/>
        <f id="1018" n="My Definitions"/>
        <f id="1010" n="Testing"/>
        <d id="1048" n="AccessPaths.xml" mdate="2007-05-11 15:07:48" cdate="2009-01-16 14:36:07" size="37" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1049" n="CoverPage.de.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1050" n="CoverPage.en.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1051" n="CoverPage.es.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1052" n="CoverPage.fr.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1053" n="CoverPage.nl.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1054" n="CoverPage.tr.pdf" mdate="2006-02-23 15:12:36" cdate="2009-01-16 14:36:07" size="117583" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1001" n="CSharp Coding Standards.pdf" mdate="2009-01-30 17:52:02" cdate="2009-01-30 17:52:02" size="115474" dformat="Office Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1055" n="htmltopdf.xml" mdate="2007-05-10 15:40:16" cdate="2009-01-16 14:36:07" size="1017" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1056" n="iso-639-language-list - Complete.xml" mdate="2007-05-09 18:29:24" cdate="2009-01-16 14:36:07" size="19822" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1057" n="iso-639-language-list.xml" mdate="2007-06-14 18:45:22" cdate="2009-01-16 14:36:07" size="3017" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1058" n="License.lic" mdate="2008-08-06 10:35:27" cdate="2009-01-20 15:29:43" size="3473" dformat="" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1059" n="mimetypes.custom.xml" mdate="2007-06-15 20:08:42" cdate="2009-01-16 14:36:07" size="55" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1060" n="mimetypes.xml" mdate="2008-05-29 10:14:50" cdate="2009-01-16 14:36:07" size="3671" dformat="XML Document" chkoutbyusername="" chkoutbyfullname="" version="1000000"/>
        <d id="1069" n="rtertert.htm" mdate="2009-02-10 15:03:15" cdate="2009-02-10 15:02:37" size="1202" dformat="Internet Document" chkoutbyusername="sysadmin" chkoutbyfullname="System Administrator" version="1000001"/>
    </response>

Remarks

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

See Also