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

GetFoldersByPage

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

Syntax

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

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

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string an infoRouter folder path
FolderFilter
    string filtering options for documents
PageNumber
    int Page Number that will be returned.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the folders 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="" page="1" pageSize="20" itemcount="5">
        <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"/>
    </response>

Remarks

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

See Also