GetDocumentVersion API¶

Returns the metadata for a specific version of a document, identified by document path and version number. The response includes the version author, size, checksum, creation and publish dates, check-in comment, and approval information.

Endpoint¶

/srv.asmx/GetDocumentVersion

Methods¶

• GET /srv.asmx/GetDocumentVersion?authenticationTicket=...&path=...&versionNumber=...

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

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

Parameters¶

Version Number Format¶

infoRouter stores and returns version numbers in a large-integer format where 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. The Number attribute in the response always uses this format.

Response¶

Success Response¶

Returns a <response> root element containing a single <Version> element. The version number is an attribute; all other fields are child elements.

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

  <Version Number="2000000">

    <VersionAuthor>jsmith</VersionAuthor>

    <VersionAuthorId>7</VersionAuthorId>

    <VersionSize>204800</VersionSize>

    <CheckSum>a1b2c3d4e5f6...</CheckSum>

    <DateCreated>2024-06-15T10:30:00.000Z</DateCreated>

    <DatePublished>2024-06-16T09:00:00.000Z</DatePublished>

    <Comment>Updated executive summary section</Comment>

    <ApprovalStatus>Approved</ApprovalStatus>

    <ApprovalDate>2024-06-17T08:00:00.000Z</ApprovalDate>

  </Version>

</response>

Version Element¶

Error Response¶

<response success="false" error="Specified version cannot be found." />

Required Permissions¶

The calling user must have at least read access to the document.

Example¶

GET Request (published version)¶

GET /srv.asmx/GetDocumentVersion

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

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

  &versionNumber=0

HTTP/1.1

GET Request (specific version)¶

GET /srv.asmx/GetDocumentVersion

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

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

  &versionNumber=2000000

HTTP/1.1

POST Request¶

POST /srv.asmx/GetDocumentVersion HTTP/1.1

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

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

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

&versionNumber=1000000

SOAP Request¶

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

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

  <soap:Body>

    <tns:GetDocumentVersion>

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

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

      <tns:versionNumber>1000000</tns:versionNumber>

    </tns:GetDocumentVersion>

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

Reads one version of a document, in the same <Version> shape GetDocumentVersions lists.

const root = await call('GetDocumentVersion', {
  authenticationTicket: ticket,
  path: '/Finance/Reports/Q1.pdf',
  versionNumber: 0            // 0 means the published version
});

const version = root.querySelector('Version');
console.log(version.getAttribute('Number'), version.querySelector('CheckSum').textContent);

A version number nothing uses is answered 4041, "the specified version cannot be found". Worth noting alongside DeleteDocumentVersion, which answers the identical condition with 4000 and a message about the file being in use - this operation is the one that reports it correctly.

Notes¶

• All date fields use UTC ISO 8601 format (yyyy-MM-ddTHH:mm:ss.fffZ). Empty string means the date is not set.

• <CheckSumError> is only present in the response when the checksum computation fails; it does not appear on successful checksum retrieval.

• Empty child elements (e.g. <Comment/>) are always present in the response even if the value is empty.

• Version numbers between 1 and 999,999 will not match any stored version and return an error. Use 0 or the modern format (--- 1000000).

• To retrieve the full list of versions for a document, use GetDocumentVersions.

Related APIs¶

• GetDocumentVersions - Get the full version history list for a document

• GetDocument - Get document properties including current version number

• DownloadDocumentVersion - Download a specific version as a byte array

Error Codes¶

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

A call with no ticket signs in as the anonymous user, so a document in a library flagged as anonymous can be read without authenticating.