GetFolders2 API¶

Returns the list of direct subfolders of the specified folder in short form, applying the system's configured maximum folder display count limit. This API is used by the infoRouter UI folder panel to avoid overloading the interface with extremely large folder lists.

Endpoint¶

/srv.asmx/GetFolders2

Methods¶

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

Parameters¶

Response¶

Success Response¶

The same answer as GetFolders1: one <f> element per direct subfolder. The root describes the folder that was read.

<response success="true" error="" folderid="1170" parentid="1132" name="Reports"
          path="\Finance\Reports" folderfilter="" itemcount="2">
  <f id="1171" n="2024" />
  <f id="1172" n="2023" />
</response>

A folder with nothing to list is a success with itemcount="0" and no children.

<response> attributes¶

<f> attributes¶

Error Response¶

No folder at Path, including one the caller may not see:

<response success="false" error="Target folder cannot be found." errorCode="4041" />

A refusal raised while the folder's contents are being read - the folder holding more subfolders than MaximumDisplayFolderCount allows, or the caller not being allowed to list it - carries no errorCode:

<response success="false" error="Too many folders to navigate." />

Required Permissions¶

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

Example¶

GET Request¶

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

POST Request¶

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

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

SOAP Request¶

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

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

The same answer as GetFolders1, with one difference: the number of subfolders is capped by the MaximumDisplayFolderCount UI setting, and a folder holding more than that is refused rather than listed. It exists for the folder tree in the web UI, which must not try to draw ten thousand nodes.

const root = await call('GetFolders2', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports'
});

for (const f of root.querySelectorAll(':scope > f')) {
  console.log(f.getAttribute('id'), f.getAttribute('n'));
}

For a folder that may hold more than the cap, page through it with GetFoldersByPage instead, which has no such limit.

Notes¶

• The maximum number of returned folders is controlled by the MaximumDisplayFolderCount UI setting in infoRouter's system configuration.
• If a folder has more subfolders than the limit allows, the call fails with Too many folders to navigate. rather than returning part of the list.
• For unlimited folder listing, use GetFolders1.
• This API is primarily used by the infoRouter web UI folder tree panel.
• For full property details per folder, use GetFolders instead.

Related APIs¶

• GetFolders1 - Get subfolders with no count limit
• GetFolders - Get subfolders with full properties
• GetFoldersByPage - Get paged subfolders with filter

Error Codes¶

The errorCode values this operation returns, checked against a running server:

A call with no ticket is not automatically refused: it signs in as the anonymous user, so a folder in a library flagged as anonymous can be read without authenticating. The writes in this group refuse it with 4010.