GetFoldersAndDocuments2 API¶

Returns the list of documents and folders at the specified path in a lightweight ("ultra-fast") format. This API is optimized for speed and returns a minimal set of attributes for each item. Use this when you need a quick listing and do not require full property details.

Endpoint¶

/srv.asmx/GetFoldersAndDocuments2

Methods¶

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

Parameters¶

Response¶

Success Response¶

Folders come back as <f> and documents as <d>. The <d> element here is not the one GetFoldersAndDocuments1 returns: this API carries the published version checksum and the template id instead of the dates and the checkout, which is what makes it useful for comparing a local copy against the server.

<response success="true"
          error=""
          id="1329"
          name="Reports"
          itemcount="4">

  <!-- Folder items - id and name only -->
  <f id="42" n="2024" />
  <f id="43" n="2023" />

  <!-- Document items -->
  <d id="1494" n="Q1-Report.pdf" sz="308" pv="1000000" lv="1000000" chksum="BFDB77A6" tid="0" />
  <d id="1495" n="Q2-Report.pdf" sz="512" pv="1000000" lv="2000000" chksum="1A2B3C4D" tid="0" />

</response>

Root attributes¶

<f> - folder items¶

<d> - document items¶

Error Response¶

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

Required Permissions¶

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

Example¶

GET Request¶

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

POST Request¶

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

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

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetFoldersAndDocuments2>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:Path>/Finance/Reports</tns:Path>
    </tns:GetFoldersAndDocuments2>
  </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 leanest of the listings: <f> and <d> again, but fewer attributes on each and only an id, a name and an itemcount on the root. What a <d> carries is chosen for deciding whether a local copy is stale - lv, pv and chksum - rather than for showing a folder to a person.

Path is a non-nullable string on the REST action, so an empty one is refused by model binding with HTTP 400 before the operation runs - there is no error document to read in that case.

const root = await call('GetFoldersAndDocuments2', {
  authenticationTicket: ticket,
  Path: '/Public/ApiTests'
});

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

Version numbers here are in the large-integer scheme, where version 1 is 1000000.

Notes¶

• Returns only direct children (one level deep) of the specified path.
• This API uses an ultra-fast internal query that returns minimal metadata per item.
• No filtering, sorting, or paging is supported. All accessible items at the path are returned.
• For full property details (rules, property sets, security), use GetFoldersAndDocuments or GetFoldersAndDocuments1.
• For filtering and paging, use GetFoldersAndDocumentsByPage or GetFoldersAndDocumentsByPage2.
• This lightweight API returns the short-form <f> / <d> elements. Extended attributes - property sets, security, rules, UserViewStatus, AIEnhanced - are not included. Use GetFoldersAndDocuments for the full <document> element.

Related APIs¶

• GetFoldersAndDocuments - Full property listing
• GetFoldersAndDocuments1 - Short-form listing
• GetFoldersAndDocumentsByPage - Paged listing with filtering
• GetFoldersAndDocumentsByPage2 - Advanced paged listing with sorting

Error Codes¶

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

A call with no ticket at all is not automatically refused: it signs in as the anonymous user, so a library flagged as anonymous can be listed without authenticating. Everything else answers 4041, because a folder the anonymous user cannot see is not told apart from one that does not exist.