FolderExists1 API¶

Determines whether a subfolder with the given name exists inside the specified parent folder. Returns success if the subfolder is found, or an error if it does not exist. Use this variant when you have the parent path and the subfolder name as separate values.

Endpoint¶

/srv.asmx/FolderExists1

Methods¶

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

Parameters¶

Response¶

Success Response -" Subfolder Exists¶

<response success="true" />

Error Response -" Subfolder Does Not Exist¶

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

The API returns success="true" if the named subfolder exists inside the parent folder. Otherwise an error is returned.

Required Permissions¶

The calling user must be authenticated and have at least read access to the parent folder.

Example¶

GET Request¶

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

POST Request¶

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

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

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:FolderExists1>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:FolderPath>/Finance/Reports</tns:FolderPath>
      <tns:FolderName>2024</tns:FolderName>
    </tns:FolderExists1>
  </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;
}

Asks whether a parent folder has a subfolder of a given name. The same question as FolderExists asked in two parts.

It does not return a boolean. A folder that is there is a plain success with nothing in it, and a folder that is not is a 4041 failure. success is the answer; there is no exists attribute to read, and a failure here is the expected result rather than a fault to report.

const response = await fetch('/srv.asmx/FolderExists1?' + new URLSearchParams({
  authenticationTicket: ticket, FolderPath: '/Finance/Reports', FolderName: '2026'
}));
const root = new DOMParser().parseFromString(await response.text(), 'text/xml').documentElement;
const exists = root.getAttribute('success') === 'true';

FolderName is matched whole, not as a filter, and an empty one is refused by model binding with HTTP 400 rather than reaching the operation.

Notes¶

• This variant accepts the parent path and folder name as separate parameters, which is useful when building folder paths programmatically.
• Use FolderExists instead if you already have the full path to the folder.
• The check is case-insensitive for folder names on most configurations.

Related APIs¶

• FolderExists - Check folder existence using a full path
• GetFolder - Retrieve folder properties
• CreateFolder1 - Create a subfolder with parent path and name as separate parameters

Error Codes¶

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