GetDocument

# 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¶

Parameter	Type	Required	Description
`AuthenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`Path`	string	Yes	Full infoRouter path to the document (e.g. `/Finance/Reports/Q1-Report.pdf`), or a short document ID path (`~D{id}` or `~D{id}.ext`, e.g. `~D1051` or `~D1051.pdf`).
`withPropertySets`	bool	Yes	`true` to include applied custom property set data (`<PropertySets>` child element). `false` to omit.
`withSecurity`	bool	Yes	`true` to include the access control list (`<AccessList>` child element). `false` to omit.
`withOwner`	bool	Yes	`true` to include owner user information as a child element. `false` to omit.
`withVersions`	bool	Yes	`true` to include document version history (`<Versions>` child element). `false` to omit.

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-01"
            ModificationDate="2024-06-15"
            CheckoutDate=""
            CheckoutBy=""
            CheckoutByUserName=""
            Size="204800"
            Type="PDF Document"
            PercentComplete="100"
            CompletionDate=""
            Importance="1"
            RetentionDate=""
            DispositionDate=""
            ExpirationDate=""
            RegisterDate="2024-03-01"
            RegisteredBy="jsmith"
            DocTypeID="0"
            DocTypeName=""
            VersionNumber="3"
            PublishedVersionNumber="3"
            PublishingRule="PublishingNotRequired"
            OwnerName="jsmith"
            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">

    <!-- Included only when withPropertySets=true -->
    <PropertySets> ... </PropertySets>

    <!-- Included only when withSecurity=true -->
    <AccessList DateApplied="2024-03-01" AppliedBy="jsmith" InheritedSecurity="true"> ... </AccessList>

    <!-- Included only when withOwner=true -->
    <User UserID="7" UserName="jsmith" FullName="John Smith" ... />

    <!-- Included only when withVersions=true -->
    <Versions> ... </Versions>

  </document>

</response>

Document Element Attributes¶

Attribute	Description
`DocumentID`	Unique integer ID of the document.
`Name`	Document file name.
`Path`	Backslash-separated infoRouter path to the containing folder.
`Description`	Document description text.
`UpdateInstructions`	Instructions for the next person checking in an update.
`CreationDate`	Date the document was created (`yyyy-MM-dd` format).
`ModificationDate`	Date the document was last modified.
`CheckoutDate`	Date the document was checked out, or empty if not checked out.
`CheckoutBy`	Display name of the user who has the document checked out, or empty.
`CheckoutByUserName`	Login name of the user who has the document checked out, or empty.
`Size`	File size in bytes.
`Type`	Human-readable document type / MIME description.
`PercentComplete`	Completion percentage (0–100).
`CompletionDate`	Scheduled completion date, or empty if not set.
`Importance`	Importance level (integer).
`RetentionDate`	Calculated retain-until date, or empty if not set.
`DispositionDate`	Scheduled disposition date, or empty if not set.
`ExpirationDate`	Document expiration date, or empty if not set.
`RegisterDate`	Date the document was registered / first uploaded.
`RegisteredBy`	Login name of the user who registered the document.
`DocTypeID`	Document type definition ID (`0` if none assigned).
`DocTypeName`	Document type name, or empty if none assigned.
`VersionNumber`	Latest (working) version number.
`PublishedVersionNumber`	Published version number (`0` if no published version exists).
`PublishingRule`	Publishing rule name (e.g. `PublishingNotRequired`, `MustBePublished`).
`OwnerName`	Login name of the document owner.
`WorkflowId`	Active workflow ID (`0` if not in a workflow).
`WorkflowName`	Active workflow name, or empty.
`WorkflowStepNumber`	Current workflow step number.
`WorkflowStepName`	Current workflow step name, or empty.
`Author`	Author metadata field.
`Language`	Language metadata field.
`Source`	Source metadata field.
`ApprovalStatus`	Approval status string (e.g. `Approved`, `Pending`).
`ClassificationLevel`	Classification level name (`NoMarkings`, `Confidential`, `Secret`, etc.).
`ClassificationLevelId`	Integer code for the classification level (0–4).
`DeclassifyOn`	Scheduled declassification date, or empty if not set.
`DomainId`	Integer ID of the domain/library containing this document.
`DomainName`	Name of the domain/library.
`DowngradeOn`	Scheduled downgrade date, or empty if not set.
`FolderId`	Integer ID of the containing folder.
`Foldername`	Name of the containing folder.
`IsShortcut`	`TRUE` if this document is a shortcut to another document; otherwise `FALSE`.
`TargetDocumentId`	ID of the target document if this is a shortcut; otherwise `0`.
`LastISOReviewDate`	Last ISO review date, or empty if not set.
`NextISOReviewDate`	Next ISO review date, or empty if not set.
`OwnerId`	Integer user ID of the document owner.
`RegisterById`	Integer user ID of the user who registered the document.
`TemplateID`	Template ID used to create the document (`0` if not template-based).
`VersionCount`	Total number of versions for this document.

Optional Child Elements¶

Element	Enabled by	Description
`<PropertySets>`	`withPropertySets=true`	Custom property set fields and values applied to the document.
`<AccessList>`	`withSecurity=true`	Access control list (users, groups, rights) for the document.
`<User>`	`withOwner=true`	Owner user details.
`<Versions>`	`withVersions=true`	Full version history list for the document.

Error Response¶

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

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>

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.

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¶

Error	Description
`[900] Authentication failed`	Invalid or missing authentication ticket.
`[901] Session expired or Invalid ticket`	The ticket has expired or does not exist.
Document not found	The specified path does not resolve to an existing document.
`SystemError:...`	An unexpected server-side error occurred.

For detailed documentation visit: https://support.inforouter.com/api-docs/GetDocument