GetDispositionLog API¶

Returns the disposition log for documents matching the specified date range and path filter. Each entry represents a retention and disposition action performed on a document.

Endpoint¶

/srv.asmx/GetDispositionLog

Methods¶

GET /srv.asmx/GetDispositionLog?authenticationTicket=...&startDate=...&endDate=...&pathFilter=...
POST /srv.asmx/GetDispositionLog (form data)
SOAP Action: http://tempuri.org/GetDispositionLog

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`
`startDate`	DateTime	No	Start date for the log query range
`endDate`	DateTime	No	End date for the log query range
`pathFilter`	string	No	Path filter with optional wildcard (e.g. `\MyLibrary\Reports*`)

Response Structure¶

Success Response¶

<response success="true">
  <logs>
    <LOGITEM TYPE="DOCUMENT" NAME="Policy_2024.docx" PATH="\MyLibrary\Policies" DATE="2026-02-01 14:30:00" ID="1234" DOMAINID="1" USERID="5" FULLNAME="John Smith" COMMENTS="Retention period expired. Document disposed per schedule." />
    <LOGITEM TYPE="DOCUMENT" NAME="Contract_Old.pdf" PATH="\MyLibrary\Contracts" DATE="2026-01-15 10:00:00" ID="1235" DOMAINID="1" USERID="8" FULLNAME="Jane Doe" COMMENTS="Manual disposition approved by records manager." />
  </logs>
</response>

Empty Result¶

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

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Log Entry Attributes¶

Each log element contains:

Attribute	Type	Description
`TYPE`	string	Object type: `DOCUMENT`, `FOLDER`, or `DOMAIN`
`ID`	integer	Object identifier
`NAME`	string	Name of the disposed object
`DATE`	DateTime	Date and time of the disposition action
`DOMAINID`	integer	Domain/library identifier
`PATH`	string	Path of the disposed object
`USERID`	integer	User identifier who performed the disposition
`FULLNAME`	string	Full name of the user who performed the disposition
`COMMENTS`	string	Comments associated with the disposition action

Required Permissions¶

User must be authenticated (valid authentication ticket required)
User must have ViewAuditLogs admin permission

Example Requests¶

Request (GET)¶

GET /srv.asmx/GetDispositionLog?authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary* HTTP/1.1
Host: server.example.com

Request (POST)¶

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

authenticationTicket=abc123-def456&startDate=2026-01-01&endDate=2026-02-01&pathFilter=\MyLibrary*

Request (SOAP 1.1)¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/GetDispositionLog"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDispositionLog xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
      <startDate>2026-01-01</startDate>
      <endDate>2026-02-01</endDate>
      <pathFilter>\MyLibrary*</pathFilter>
    </GetDispositionLog>
  </soap:Body>
</soap:Envelope>

Notes¶

Results are ordered by action date descending (most recent first).
The pathFilter parameter supports wildcard matching using * (e.g., \MyLibrary\Reports*).
If startDate and endDate are omitted, all available log entries are returned.
UTC dates are automatically converted to local server time.
The COMMENTS attribute contains the disposition reason or notes recorded at the time of the action.

Error Codes¶

Common error responses:

Error	Description
`[901]Session expired or Invalid ticket`	Invalid or expired authentication ticket
Insufficient permissions	Caller does not have `ViewAuditLogs` admin permission

GetDeleteLog - Get deletion log entries
GetNewDocumentsAndFoldersLog - Get creation log entries for new documents and folders
GetRetentionSourceAuthorities - List all retention source authorities

Version History¶

New: Added to provide programmatic access to disposition log previously only available through the Control Panel UI