DeleteDownloadHandler

# DeleteDownloadHandler API

Deletes a download handler and discards its associated temporary file on the server. Use this to clean up after a chunked download is complete or if the download session is cancelled before all chunks are retrieved.

Endpoint¶

/srv.asmx/DeleteDownloadHandler

Methods¶

• GET /srv.asmx/DeleteDownloadHandler?authenticationTicket=...&DownloadHandler=...
• POST /srv.asmx/DeleteDownloadHandler (form data)
• SOAP Action: http://tempuri.org/DeleteDownloadHandler

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Error message" />

Required Permissions¶

Any authenticated user may call this API. The handler is resolved by GUID — only the handler file path associated with the current user's session is deleted.

Chunked Download Workflow¶

Download handlers are used in chunked download scenarios to stage large files server-side before the client retrieves them in pieces:

1. GetDownloadHandler (or GetDownloadHandlerByVersion / DownloadZipWithHandler) — Prepare the file and obtain a handler GUID.
2. DownloadFileChunk — Download the file content in sequential chunks using the handler GUID.
3. DeleteDownloadHandler — Clean up the handler and its temporary file once all chunks are downloaded or if the download is abandoned.

Example¶

GET Request¶

GET /srv.asmx/DeleteDownloadHandler
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DownloadHandler=a1b2c3d4-e5f6-7890-abcd-ef1234567890
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DownloadHandler=a1b2c3d4-e5f6-7890-abcd-ef1234567890

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:DeleteDownloadHandler>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:DownloadHandler>a1b2c3d4-e5f6-7890-abcd-ef1234567890</tns:DownloadHandler>
    </tns:DeleteDownloadHandler>
  </soap:Body>
</soap:Envelope>

Notes¶

• If the handler's temporary file does not exist (e.g. already cleaned up), the call still returns success — no error is raised.
• Passing a string that is not a valid GUID format returns an error immediately without performing any authentication check.
• Always call DeleteDownloadHandler after finishing a chunked download to free temporary server storage, even if the download was not fully completed.

Related APIs¶

• GetDownloadHandler - Prepare a document for chunked download and obtain a handler GUID
• GetDownloadHandlerByVersion - Prepare a specific document version for chunked download
• DownloadZipWithHandler - Prepare a zip archive of folders and documents for chunked download
• DownloadFileChunk - Download a chunk of a file using a handler
• DeleteUploadHandler - Delete an upload handler and discard its staged data

Error Codes¶

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