Skip to content

UploadDocument

# UploadDocument API

Uploads a new document or creates a new version of an existing document at the specified path using a raw byte array. If no document exists at the path, a new document is created. If a document already exists, a new version is added. This is the base upload method; use numbered variants (UploadDocument1 through UploadDocument4) for additional options such as version comments, post-upload checkout, and extended XML parameters.

Endpoint

/srv.asmx/UploadDocument

Methods

  • GET /srv.asmx/UploadDocument?authenticationTicket=...&path=...&fileContent=...
  • POST /srv.asmx/UploadDocument (form data — recommended for binary content)
  • SOAP Action: http://tempuri.org/UploadDocument

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
path string Yes Full infoRouter destination path including file name (e.g. /Finance/Reports/Q1-Report.pdf). If the document already exists at this path a new version is created.
fileContent byte[] Yes The raw binary content of the file to upload, encoded as a Base64 string when sent over HTTP.

Response

Success Response

<root success="true" DocumentId="12345" VersionId="1000001" />
Attribute Description
success "true" on success.
DocumentId The numeric ID of the created or updated document.
VersionId The internal version ID of the newly created version.

Error Response

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

Required Permissions

The calling user must have write (upload) permission on the destination folder.

Example

POST Request (recommended for binary files)

POST /srv.asmx/UploadDocument HTTP/1.1
Content-Type: multipart/form-data; boundary=----FormBoundary

------FormBoundary
Content-Disposition: form-data; name="authenticationTicket"

3f2504e0-4f89-11d3-9a0c-0305e82c3301
------FormBoundary
Content-Disposition: form-data; name="path"

/Finance/Reports/Q1-2024-Report.pdf
------FormBoundary
Content-Disposition: form-data; name="fileContent"; filename="Q1-2024-Report.pdf"
Content-Type: application/octet-stream

[binary file content]
------FormBoundary--

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UploadDocument>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:path>/Finance/Reports/Q1-2024-Report.pdf</tns:path>
      <tns:fileContent>JVBERi0xLjQ...</tns:fileContent>
    </tns:UploadDocument>
  </soap:Body>
</soap:Envelope>

Notes

  • For large files, use the chunked upload approach: CreateUploadHandler → UploadFileChunk (repeat) → UploadDocumentWithHandler.
  • The file extension in path determines the document's MIME type and thumbnail behavior.
  • If a document already exists at the path, a new version is created automatically. The document ID remains the same.
  • The folder path component of path must already exist. Use CreateFolder to create missing folders first.
  • For uploads with version comments, use UploadDocument1. For post-upload checkout, use UploadDocument2. For all options in XML, use UploadDocument4.

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.
Folder not found The destination folder in the path does not exist.
Access denied The user does not have upload permission on the destination folder.
SystemError:... An unexpected server-side error occurred.

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