Skip to content

SetFolderCutoffDate

# SetFolderCutoffDate API

Sets the cutoff date on the specified folder and, optionally, on its subfolders and documents. Returns a log of the operation. If any individual item fails, the overall success flag returns false even if other items succeeded.

Endpoint

/srv.asmx/SetFolderCutoffDate

Methods

  • GET /srv.asmx/SetFolderCutoffDate?authenticationTicket=...&path=...&cutoffDate=...&includeSubFolders=...&includeDocuments=...
  • POST /srv.asmx/SetFolderCutoffDate (form data)
  • SOAP Action: http://tempuri.org/SetFolderCutoffDate

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
path string Yes Full infoRouter path to the folder (e.g. /Finance/Reports).
cutoffDate DateTime Yes The cutoff date to set. Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss. UTC dates are automatically converted to server local time.
includeSubFolders bool Yes If true, the cutoff date is also applied to all subfolders recursively.
includeDocuments bool Yes If true, the cutoff date is also applied to all documents within the folder (and subfolders if includeSubFolders=true).

Response

Success Response — No Errors

<response success="true" error="" />

Partial Success Response — Some Items Failed

<response success="false" error="MultiStatus">
  <logitem path="/Finance/Reports/Q1.pdf" status="failed" message="Access denied." />
  <logitem path="/Finance/Reports/Q2.pdf" status="success" />
</response>

Error Response

<response success="false" error="Folder not found." />
Attribute Description
success "true" only if all operations succeeded without any errors. "false" if any individual item failed.
error "MultiStatus" indicates a partial result with per-item log entries. Otherwise contains a single error message.

Required Permissions

The calling user must have write permission on the folder. For documents, write permission on each document is also required.

Example

GET Request

GET /srv.asmx/SetFolderCutoffDate
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &path=/Finance/Reports
  &cutoffDate=2025-12-31
  &includeSubFolders=true
  &includeDocuments=true
HTTP/1.1

POST Request

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&path=/Finance/Reports
&cutoffDate=2025-12-31
&includeSubFolders=true
&includeDocuments=true

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:SetFolderCutoffDate>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:path>/Finance/Reports</tns:path>
      <tns:cutoffDate>2025-12-31</tns:cutoffDate>
      <tns:includeSubFolders>true</tns:includeSubFolders>
      <tns:includeDocuments>true</tns:includeDocuments>
    </tns:SetFolderCutoffDate>
  </soap:Body>
</soap:Envelope>

Notes

  • The cutoff date is used in infoRouter's records management and compliance features to mark when a document or folder is no longer considered active.
  • UTC date values are automatically converted to the server's local time before storage.
  • When success="false" with error="MultiStatus", inspect the logitem child elements for per-item results.
  • To remove the cutoff date, use RemoveFolderCutoffDate.
  • To set the cutoff date on a single document, use SetDocumentCutoffDate.

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 write permission on the folder.
MultiStatus Some items succeeded and some failed. See logitem elements for details.
SystemError:... An unexpected server-side error occurred.

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