? Back to Index

GetCheckoutLog API

Returns the checkout log for documents matching the specified date range and path filter.

Endpoint

/srv.asmx/GetCheckoutLog

Methods

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>
    <log TYPE="DOCUMENT" ID="1234" NAME="Report.docx" DATE="2026-02-01 14:30:00" DOMAINID="1" PATH="\MyLibrary\Reports" USERID="5" FULLNAME="John Smith" />
    <log TYPE="DOCUMENT" ID="1235" NAME="Invoice.pdf" DATE="2026-01-28 09:15:00" DOMAINID="1" PATH="\MyLibrary\Finance" USERID="8" FULLNAME="Jane Doe" />
  </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 (typically DOCUMENT)
ID integer Document identifier
NAME string Name of the checked out document
DATE DateTime Date and time of the checkout action
DOMAINID integer Domain/library identifier
PATH string Parent path of the document
USERID integer User identifier who performed the checkout
FULLNAME string Full name of the user who performed the checkout

Required Permissions

Example Requests

Request (GET)

GET /srv.asmx/GetCheckoutLog?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/GetCheckoutLog 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/GetCheckoutLog"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCheckoutLog xmlns="http://tempuri.org/">
      <AuthenticationTicket>abc123-def456</AuthenticationTicket>
      <StartDate>2026-01-01</StartDate>
      <EndDate>2026-02-01</EndDate>
      <PathFilter>\MyLibrary*</PathFilter>
    </GetCheckoutLog>
  </soap:Body>
</soap:Envelope>

Notes

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

Version History