GetDocumentViewLog API¶

Returns the complete view/access log for a specified document, showing all users who have accessed the document and when. This API retrieves entries from both the current view log (VIEWLOG table) and historical read logs (HISTORY_READ table).

Endpoint¶

/srv.asmx/GetDocumentViewLog

Methods¶

• GET /srv.asmx/GetDocumentViewLog?authenticationTicket=...&path=...

• POST /srv.asmx/GetDocumentViewLog (form data)

• SOAP Action: http://tempuri.org/GetDocumentViewLog

Parameters¶

Response¶

Success Response¶

Returns a <response> root element containing a <ViewLog> element, which holds zero or more <Version> child elements. Each element represents a view/access event for a specific version of the document.

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

  <ViewLog>

    <Version Number="2000000" 

             UserID="7" 

             Viewer="John Smith" 

             ViewDate="2024-06-15T10:30:00.000Z" />

    <Version Number="2000000" 

             UserID="12" 

             Viewer="Jane Doe" 

             ViewDate="2024-06-14T14:20:00.000Z" />

    <Version Number="1000000" 

             UserID="7" 

             Viewer="John Smith" 

             ViewDate="2024-05-01T09:15:00.000Z" />

  </ViewLog>

</response>

Version Element Attributes¶

Error Response¶

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

Required Permissions¶

The calling user must have at least read access to the document. Additionally, the user must have the "Read View Log" permission (IRAction.DocumentReadViewLog) for the document. This permission is typically granted to:

• Document owner

• System administrators

• Domain/library managers

• Users with explicit "Read View Log" permission on the document's ACL

Example¶

GET Request¶

GET /srv.asmx/GetDocumentViewLog

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &path=/Finance/Reports/Q1-2024-Report.pdf

HTTP/1.1

POST Request¶

POST /srv.asmx/GetDocumentViewLog HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&path=/Finance/Reports/Q1-2024-Report.pdf

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:GetDocumentViewLog>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

      <tns:Path>/Finance/Reports/Q1-2024-Report.pdf</tns:Path>

    </tns:GetDocumentViewLog>

  </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;
}

Reports who has read a document, and which version they read.

const root = await call('GetDocumentViewLog', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/Q1.pdf'
});

for (const entry of root.querySelectorAll('ViewLog > Version')) {
  console.log(entry.getAttribute('Viewer'),
              entry.getAttribute('Number'),
              entry.getAttribute('ViewDate'));
}

Unlike most of the reads in this group, this one is refused to a caller with no ticket even in a library flagged as anonymous: who read what is about people rather than about content.

Notes¶

• Combined Data Sources: The response combines entries from both the active view log (VIEWLOG table) and the historical read log (HISTORY_READ table).

• Version-Specific: Each log entry is associated with a specific version number. Users may appear multiple times if they accessed different versions.

• Duplicate Entries Possible: The same user may have multiple entries for the same version if they accessed it multiple times. Entries are not deduplicated.

• Sorting: Results are not guaranteed to be in any specific order. Consider sorting by ViewDate or UserID in your client application if needed.

• Date Format: All ViewDate attributes use UTC ISO 8601 format (yyyy-MM-ddTHH:mm:ss.fffZ).

• Version Number Format: The Number attribute uses the modern format (version numbers pack a major, a minor and a revision into one integer as major * 1000000 + minor * 1000 + revision, so the first version is 1000000 and the second is 1000001 - not 2000000, which would be major version 2.).

• Empty Results: If no one has accessed the document, an empty <ViewLog/> element is returned (not an error).

• Short Path Support: The path parameter supports short document ID notation: ~D123 or ~D123.pdf.

• Permission Checking: If the user lacks "Read View Log" permission, an access denied error is returned even if they have read access to the document.

Use Cases¶

1. Audit Reports: Track who has accessed sensitive or regulated documents for compliance purposes.

2. Security Monitoring: Monitor access to confidential documents and detect unauthorized viewing attempts.

3. User Activity Analysis: Understand document usage patterns and identify which users are actively engaging with content.

4. Compliance Verification: Verify that required personnel have reviewed mandatory documents (e.g., policies, training materials).

5. Version Adoption Tracking: See which versions of a document users are accessing to gauge version adoption rates.

Related APIs¶

• GetUserViewLog - Get complete view log history for a specific user across all documents

• GetUserViewLog1 - Get view log history for a specific user filtered by date range

• GetDocumentReadLogHistory - Get detailed read log history for a specific document and user

Error Codes¶

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