UpdateDocumentThumbnail API¶

Uploads or replaces the thumbnail image for a document. Any existing thumbnail is overwritten.

Endpoint¶

/srv.asmx/UpdateDocumentThumbnail

Methods¶

• POST /srv.asmx/UpdateDocumentThumbnail (form data)
• SOAP Action: http://tempuri.org/UpdateDocumentThumbnail

Parameters¶

Response¶

Success Response¶

<root success="true" />

Error Response¶

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

Required Permissions¶

The calling user must have Change Document Properties permission on the document.

Example¶

Request (POST)¶

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

authenticationTicket=abc123&documentPath=/Finance/Reports/Q1Summary.pdf&thumbnailContent=<base64-encoded-image-bytes>

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;
}

POST only. The content is a byte[], which model binding cannot read from a query string: a GET is answered HTTP 415 Unsupported Media Type before the operation runs. Post it as a form field holding base64.

const body = new URLSearchParams({
  authenticationTicket: ticket,
  documentPath: '/Finance/Reports/Q1.pdf',
  thumbnailContent: btoa(String.fromCharCode(...pngBytes))
});

await fetch('/srv.asmx/UpdateDocumentThumbnail', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body
});

Read it back with GetDocumentThumbnail, and clear it with DeleteDocumentThumbnail so that the server regenerates one on next use.

Notes¶

• If a thumbnail already exists for the document it is replaced by the new content.
• To retrieve the current thumbnail, use GetDocumentThumbnail.
• To remove a thumbnail without replacing it, use DeleteDocumentThumbnail.
• JPEG is the native thumbnail format used by infoRouter since 9.0; before that it was GIF. Whatever is uploaded is re-encoded as a JPEG of at most 240 pixels on the longest edge, with the aspect ratio preserved and no enlargement of a smaller image, so the stored thumbnail will not match the uploaded bytes.

Related APIs¶

• GetDocumentThumbnail — Retrieve the thumbnail image bytes for a document.
• DeleteDocumentThumbnail — Remove the thumbnail image from a document.
• GetDocument — Get full document properties including the ThumbnailExists flag.

Error Codes¶

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