GetDocument API¶

Returns the full metadata and properties of a single document identified by its infoRouter path. Optional parameters control whether additional detail (custom property sets, access control list, owner, version history) is included in the response.

Endpoint¶

/srv.asmx/GetDocument

Methods¶

• GET /srv.asmx/GetDocument?AuthenticationTicket=...&Path=...&withPropertySets=...&withSecurity=...&withOwner=...&withVersions=...

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

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

Parameters¶

Path Formats¶

Both full paths and short ID paths are accepted:

/Finance/Reports/Q1-2024-Report.pdf

~D1051

~D1051.pdf

Performance tip: Set all boolean flags to false for the fastest, most compact response. Only enable the flags your application actually needs.

Response¶

Success Response¶

Returns a <response> root element with a single <document> child element containing the document's properties.

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

  <document DocumentID="1051"

            Name="Q1-2024-Report.pdf"

            Path="\Finance\Reports"

            Description="Q1 financial summary"

            UpdateInstructions=""

            CreationDate="2024-03-01T09:00:00.000Z"

            ModificationDate="2024-06-15T14:30:00.000Z"

            CheckoutDate=""

            CheckoutBy=""

            CheckoutByUserName=""

            Size="204800"

            Type="PDF Document"

            PercentComplete="100"

            CompletionDate=""

            Importance="Normal"

            RetentionDate=""

            DispositionDate=""

            CutoffDate=""

            RDDefId="0"

            ExpirationDate=""

            RegisterDate="2024-03-01T09:00:00.000Z"

            RegisteredBy="John Smith"

            DocTypeID="0"

            DocTypeName=""

            AIEnhanced="17"

            AIExtractConfidence="65"

            VersionNumber="3000000"

            PublishedVersionNumber="3000000"

            PublishingRule="LATEST"

            OwnerName="John Smith"

            WorkflowId="0"

            WorkflowName=""

            WorkflowStepNumber="0"

            WorkflowStepName=""

            Author=""

            Language=""

            Source=""

            ApprovalStatus="Approved"

            ClassificationLevel="NoMarkings"

            ClassificationLevelId="0"

            DeclassifyOn=""

            DomainId="3"

            DomainName="Finance"

            DowngradeOn=""

            FolderId="10"

            Foldername="Reports"

            IsShortcut="FALSE"

            TargetDocumentId="0"

            LastISOReviewDate=""

            NextISOReviewDate=""

            OwnerId="7"

            RegisterById="7"

            TemplateID="0"

            VersionCount="3"

            UserViewStatus="2">

    <!-- Included only when withPropertySets=true -->

    <PropertySets> ... </PropertySets>

    <!-- Included only when the description has a recorded author -->

    <DescriptionLog AppliedById="4" AppliedBy="System Administrator" DateApplied="2024-03-01T09:14:22.000Z" />

    <!-- Included only when withSecurity=true -->

    <AccessList DateApplied="2024-03-01T09:00:00.000Z" AppliedBy="John Smith" InheritedSecurity="true"> ... </AccessList>

    <!-- Included only when withOwner=true -->

    <User exists="true" UserID="7" FirstName="John" LastName="Smith" Email="jsmith@example.com" MobileNumber="" Enabled="TRUE" UserName="jsmith" />

    <!-- Included only when withVersions=true -->

    <Versions> ... </Versions>

  </document>

</response>

Document Element Attributes¶

Optional Child Elements¶

<DescriptionLog>¶

A description can be typed by a person or produced by infoRouter Connect, and this is how a client tells them apart - a Connect-written description is attributed to the system account. The same three attributes GetPropertySets, GetDocumentSummary and GetDocumentAbstract use.

The element is absent where there is no author to report: a document with no description, one whose description was written before the author was recorded, and a document old enough that its description is still kept in the warehouse rather than the database. Saying nothing is deliberate - it beats reporting user 0.

It sits beside the description rather than on it because Description is an attribute, and an XML attribute cannot carry attributes of its own.

Error Response¶

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

AIEnhanced¶

AIEnhanced says which of the document's attributes infoRouter Connect produced, one bit per attribute, so a listing can badge a document and say which parts a model wrote without reading each of them.

AIEnhanced="17" is 1 | 16: the summary and the document type.

A bit is set when Connect writes that attribute, and it survives a correction. The flag says where the attribute came from, not who edited it last: a person who fixes a generated summary keeps the flag, because a reader still wants to know it began as the model's work.

A bit is cleared only when the attribute itself is removed - there is then nothing left for it to describe:

Whether the values still need somebody's attention is a separate question, answered by AIExtractConfidence, which a review does clear. The two together say more than either alone: ExtractedData set with AIExtractConfidence of 0 means "extracted, and somebody has been through it", which no single flag could express.

A document that predates the flag reports 0: nothing was produced for it, which is what 0 means. There is no "unknown" state.

AIExtractConfidence¶

AIExtractConfidence says how sure infoRouter Connect was about the weakest value it extracted into the document's property sets, as a percentage from 0 to 100. It is there so a listing can highlight a document whose extracted values are worth a person's attention.

The lowest of the fields Connect actually filled, because a property set is only as trustworthy as its worst answer and a listing has room for one number. A field a person had already answered does not count towards it - it carries no confidence of the service's at all.

0 means nothing to review. Saving a document's property set values clears it to 0 - that save is what marks the document reviewed. The ExtractedData bit of AIEnhanced is not cleared with it: the values are still the model's work, they have just been checked. To tell a reviewed document from one nothing was ever extracted for, read the two together - ExtractedData set with a confidence of 0 is "extracted, and reviewed".

Suggested bands, as half-open intervals so they tile with no gap and nothing in two bands at once:

There is no confidence threshold. Whatever Connect finds is written, however unsure it was, on the reasoning that a value a person is going to review is worth more than the blank it would otherwise leave. So the scale runs the whole way: a value of 12 means Connect wrote something it had very little confidence in, and that document is exactly the one to send somebody to.

A written value never reports 0, because 0 means "nothing here needs reviewing". The lowest a written value reports is 1.

A field Connect found nothing for is still left empty and carries no confidence, so it does not enter this number. A document where two fields were extracted at 95 and eight were found nothing for reports 95. This value reports how good the answers are, not how many of them there are.

Required Permissions¶

The calling user must have at least read access to the document. If the document does not exist or is not accessible to the user, an error response is returned.

Example¶

GET Request¶

GET /srv.asmx/GetDocument

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

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

  &withPropertySets=false

  &withSecurity=false

  &withOwner=false

  &withVersions=false

HTTP/1.1

GET Request (short ID path)¶

GET /srv.asmx/GetDocument

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

  &Path=~D1051

  &withPropertySets=false

  &withSecurity=false

  &withOwner=false

  &withVersions=false

HTTP/1.1

POST Request¶

POST /srv.asmx/GetDocument HTTP/1.1

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

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

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

&withPropertySets=false

&withSecurity=false

&withOwner=false

&withVersions=false

SOAP Request¶

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

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

  <soap:Body>

    <tns:GetDocument>

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

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

      <tns:withPropertySets>false</tns:withPropertySets>

      <tns:withSecurity>false</tns:withSecurity>

      <tns:withOwner>false</tns:withOwner>

      <tns:withVersions>false</tns:withVersions>

    </tns:GetDocument>

  </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 one document as a <document> element.

const root = await call('GetDocument', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/Q1.pdf',
  withPropertySets: false,
  withSecurity: false,
  withOwner: false,
  withVersions: false
});

const document = root.querySelector('document');
console.log(document.getAttribute('DocumentID'),
            document.getAttribute('Size'),
            document.getAttribute('CheckoutByUserName') || '(not checked out)');

The four flags never change which document comes back, only how much is written about it: withOwner adds a <User> child, withPropertySets a <Propertysets>, withSecurity an <AccessList> and withVersions the version history. With all four off the element has no children at all.

Version numbers are in the large-integer scheme, where version 1 is 1000000.

Notes¶

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

• If the document does not exist or the user does not have access, an error response is returned with success="false".

• The Path attribute in the response element uses backslash separators and represents the containing folder path, not the full document path.

• Setting all boolean flags to false returns only the core document attributes, which is the fastest and most compact response.

Related APIs¶

• GetFoldersAndDocuments - List documents and sub-folders within a folder path

• DocumentExists - Check whether a document exists and retrieve its CRC32 checksums

• DownloadDocument - Download the latest version of a document as a raw byte array

• GetDocumentVersions - Get the version history list for a document

Error Codes¶

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