GetDocumentAbstract1 API¶

Returns the full-text abstract (indexed text content) of a specified version of a document. This is the current preferred API for retrieving document abstracts. It uses a consistent XML response structure for both success and error cases, unlike the obsolete GetDocumentAbstract.

Endpoint¶

/srv.asmx/GetDocumentAbstract1

Methods¶

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

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

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

Parameters¶

Version Number Format¶

infoRouter uses a large-integer version numbering scheme where version 1 = 1000000, version 2 = 2000000, etc. Pass 0 to get the published version's abstract, or the latest version's when the document has never been published.

Response¶

Success Response¶

On success, the abstract text is returned inside a <Value> child element:

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


  <Value AppliedById="3" AppliedBy="SYSTEM" DateApplied="2024-03-15T14:32:07.000Z">This document covers the Q1 2024 financial results including


revenue figures, expense breakdowns, and year-over-year comparisons...</Value>


</response>

Who wrote the abstract¶

The element carries the author, in the same three attributes GetPropertySets uses on its <Log> node and GetDocumentSummary uses on its <Value>.

An abstract is always produced by the server - from the email parser or the content index, never typed - so in practice this is the system account. It is read from the stored row rather than assumed, which is why all three are absent on an abstract written before the author was recorded, and on a - where there is none.

Error Response¶

<response success="false" error="[900] Authentication failed" />

Both success and error use the same <response> root element -" the only difference is the presence of the <Value> child on success. This consistent structure is what makes GetDocumentAbstract1 the preferred API over the obsolete GetDocumentAbstract.

Required Permissions¶

The calling user must have at least read access to the document. The abstract is extracted from the full-text search index; if the document has not been indexed, the returned abstract may be empty.

Example¶

GET Request¶

GET /srv.asmx/GetDocumentAbstract1


  ?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/GetDocumentAbstract1


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


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


  &versionNumber=2000000


HTTP/1.1

POST Request¶

POST /srv.asmx/GetDocumentAbstract1 HTTP/1.1


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





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


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


&versionNumber=0

SOAP Request¶

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


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


  <soap:Body>


    <tns:GetDocumentAbstract1>


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


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


      <tns:versionNumber>0</tns:versionNumber>


    </tns:GetDocumentAbstract1>


  </soap:Body>


</soap:Envelope>

Notes¶

• versionNumber=0 retrieves the abstract for the published version of the document, or for its latest version when it has never been published.

• Version numbers between 1 and 999,999 are rejected with an error. Use 0 or the modern format (e.g. 1000000 for version 1, 2000000 for version 2).

• Both full infoRouter paths and short document ID paths (~D{id} or ~D{id}.ext) are accepted for the path parameter.

• The abstract is sourced from the full-text search index. If the document has not been indexed, the <Value> element may be empty.

• This API supersedes the obsolete GetDocumentAbstract, which used an <abstract> child element on success and had inconsistent XML structure between success and error cases.

Related APIs¶

• GetDocumentAbstract - Obsolete predecessor with inconsistent XML structure

• GetDocument - Get full document metadata and properties

• GetDocumentVersions - Get the version history list for a document

Error Codes¶