GetDownloadHandlerByVersion

# GetDownloadHandlerByVersion API

Stages a specific version of a document as a temporary server-side file and returns a download handler GUID along with file metadata and the negotiated chunk size. This is the version-aware counterpart to GetDownloadHandler, which always stages the latest version. Use DownloadFileChunk to retrieve the file data in sequential chunks, then DeleteDownloadHandler to clean up the temporary file when done.

Endpoint¶

/srv.asmx/GetDownloadHandlerByVersion

Methods¶

• GET /srv.asmx/GetDownloadHandlerByVersion?AuthenticationTicket=...&Path=...&PreferedChunkSize=...&VersionNumber=...
• POST /srv.asmx/GetDownloadHandlerByVersion (form data)
• SOAP Action: http://tempuri.org/GetDownloadHandlerByVersion

Parameters¶

Version Number Format¶

infoRouter stores version numbers internally as multiples of 1,000,000:

Always use the Number attribute from GetDocumentVersions to obtain the correct value — do not multiply the sequential version number yourself, as the internal numbering may not always follow this simple pattern.

Response¶

Success Response¶

The server stages the specified document version, creates a temporary handler, and returns file metadata along with the handler GUID.

<response success="true"
          Size="102400"
          ContentType="application/pdf"
          ModificationDate="2024-03-10"
          VersionNumber="1000000"
          AlterDocumentName="Q1-Report.pdf"
          RenderedContent="false"
          CRC32="a3f1c29d"
          ChunkSize="1048576"
          downloadhandler="7f3a1b2c-d4e5-6789-abcd-ef0123456789" />

Response Attributes¶

Error Response¶

<response success="false" error="[901] Session expired or Invalid ticket" />

Required Permissions¶

The calling user must have at least read access to the document. Offline (archived) documents cannot be downloaded and return an error.

Chunked Download Workflow¶

1. GetDocumentVersions              →  list versions, obtain VersionNumber for the desired version
2. GetDownloadHandlerByVersion      →  stage that version, obtain downloadhandler GUID + ChunkSize + Size
3. DownloadFileChunk (×N)           →  download chunks sequentially until lastchunk="true"
4. DeleteDownloadHandler            →  clean up the temporary staged file on the server

Chunk iteration pattern:

chunkSize   = response/@ChunkSize
totalSize   = response/@Size
handler     = response/@downloadhandler
offset      = 0

loop:
    GET /srv.asmx/DownloadFileChunk
        ?DownloadHandler={handler}
        &StartOffset={offset}
        &ChunkSize={chunkSize}

    append base64-decoded chunk bytes to output file
    offset += chunk/@chunklength

    if chunk/@lastchunk == "true": break

GET /srv.asmx/DeleteDownloadHandler?DownloadHandler={handler}

Always use chunklength from the DownloadFileChunk response (not the requested ChunkSize) when advancing StartOffset, because the final chunk may be smaller.

Example¶

GET Request¶

GET /srv.asmx/GetDownloadHandlerByVersion
  ?AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance/Reports/Q1-Report.pdf
  &PreferedChunkSize=1048576
  &VersionNumber=1000000
HTTP/1.1

POST Request¶

POST /srv.asmx/GetDownloadHandlerByVersion HTTP/1.1
Content-Type: application/x-www-form-urlencoded

AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&Path=/Finance/Reports/Q1-Report.pdf
&PreferedChunkSize=1048576
&VersionNumber=1000000

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetDownloadHandlerByVersion>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:Path>/Finance/Reports/Q1-Report.pdf</tns:Path>
      <tns:PreferedChunkSize>1048576</tns:PreferedChunkSize>
      <tns:VersionNumber>1000000</tns:VersionNumber>
    </tns:GetDownloadHandlerByVersion>
  </soap:Body>
</soap:Envelope>

Notes¶

• VersionNumber must be in the internal format (a multiple of 1,000,000). Use the Number attribute from GetDocumentVersions to obtain the correct value. Values between 1 and 999,999 are explicitly rejected by the server and will return an error.
• Passing VersionNumber=0 stages the latest version, which is equivalent to calling GetDownloadHandler.
• The PreferedChunkSize value is clamped server-side: values below 262,144 bytes (256 KB) are raised to 262,144; values above 33,554,432 bytes (32 MB) are lowered to 33,554,432. Always read the actual ChunkSize from the response.
• The staged file is stored as a temporary server-side file. Always call DeleteDownloadHandler after completing (or abandoning) a download to free disk space.
• Both full infoRouter paths and short document ID paths (~D{id} or ~D{id}.ext) are accepted for the Path parameter.
• Offline (archived) documents cannot be staged and will return an error.
• The handler is tied to the authenticated session. Do not share handler GUIDs across different user sessions.
• To download a version without chunking use DownloadDocumentVersion (returns raw bytes directly).

Related APIs¶

• GetDocumentVersions - Get the version list for a document to obtain valid VersionNumber values
• GetDownloadHandler - Create a download handler for the latest version of a document
• DownloadFileChunk - Download a single chunk of a staged file using a handler GUID
• DeleteDownloadHandler - Delete a download handler and discard the staged temporary file
• GetDownloadInfo - Get download metadata without staging a handler
• DownloadDocumentVersion - Download a specific version as a raw byte array (no chunking)

Error Codes¶

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