GetFoldersByPage

# GetFoldersByPage API

Returns a page of direct subfolders from the specified parent folder, with optional name filtering. Each page contains up to 20 folders. Use PageNumber to navigate through large folder lists.

Endpoint¶

/srv.asmx/GetFoldersByPage

Methods¶

GET /srv.asmx/GetFoldersByPage?authenticationTicket=...&Path=...&FolderFilter=...&PageNumber=...
POST /srv.asmx/GetFoldersByPage (form data)
SOAP Action: http://tempuri.org/GetFoldersByPage

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`Path`	string	Yes	Full infoRouter path to the parent folder (e.g. `/Finance`).
`FolderFilter`	string	No	Optional filter string to search for folder names containing the specified text. Pass empty string or null for no filtering.
`PageNumber`	int	Yes	Page number to retrieve (1-based). Pass `1` for the first page. Each page contains up to 20 folders.

Response¶

Success Response¶

<response success="true">
  <folder id="456" name="Reports" />
  <folder id="457" name="Invoices" />
</response>

Error Response¶

<response error="Folder not found." />

Required Permissions¶

The calling user must have read permission on the parent folder. Only accessible subfolders are returned.

Example¶

GET Request (page 1, no filter)¶

GET /srv.asmx/GetFoldersByPage
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance
  &FolderFilter=
  &PageNumber=1
HTTP/1.1

GET Request (page 2, with filter)¶

GET /srv.asmx/GetFoldersByPage
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance
  &FolderFilter=Report
  &PageNumber=2
HTTP/1.1

POST Request¶

POST /srv.asmx/GetFoldersByPage HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&Path=/Finance
&FolderFilter=
&PageNumber=1

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetFoldersByPage>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:Path>/Finance</tns:Path>
      <tns:FolderFilter></tns:FolderFilter>
      <tns:PageNumber>1</tns:PageNumber>
    </tns:GetFoldersByPage>
  </soap:Body>
</soap:Envelope>

Notes¶

Each page returns up to 20 folders.
FolderFilter performs a substring match on folder names (case-insensitive on most configurations).
To get the first page, pass PageNumber=1.
An empty response (no folder elements) indicates no more folders are available on subsequent pages.
For a combined paged listing of folders and documents, use GetFoldersAndDocumentsByPage.

GetFolders - Get all subfolders with full properties (no paging)
GetFolders1 - Get all subfolders in short form (no paging)
GetFoldersAndDocumentsByPage - Paged listing of both folders and documents

Error Codes¶

Error	Description
`[900] Authentication failed`	Invalid or missing authentication ticket.
`[901] Session expired or Invalid ticket`	The ticket has expired or does not exist.
Folder not found	The specified path does not resolve to an existing folder.
Access denied	The user does not have read permission on the folder.
`SystemError:...`	An unexpected server-side error occurred.

For detailed documentation visit: https://support.inforouter.com/api-docs/GetFoldersByPage