eoGetCopy

Action Parameter eoGetCopy
Purpose Returns a watermarked copy of the document.
Description Used to retrieve a watermarked copy of any document managed by eCore. Caller may specify watermark to apply, otherwise pre-configured system defaults will be applied based on the type of document being retrieved (eStored, electronicOriginal, or eCopy). The pre-configured system defaults are described in the defaultInstructions.xml as 'watermarkInstructions-eStore-retrieveDocument', 'watermarkInstructions-electronicOriginal-retrieveDocument', and 'watermarkInstructions-eCopy-retrieveDocument'respectively.
Type Granular
Preconditions Calling application has established a valid user session with eCore. At least one version exists for requested document.
Implementation Notes Altering the eOriginal default watermarks may cause your documents to become uncompliant with UETA and UCC (article 9, section 105). Contact eOriginal Support or your assigned eOriginal Project Team for guidance on altering eOriginal watermarks.

Parameters

Required Parameter Value Description
required dpSid Unique identifier of the document profile.
version Version identifier of the document version (1-X with 1 as the oldest).
includeDocumentType Whether or not to include the documentType attribute on the document element in the response Xml.
convertToImage Whether or not to retrieve as an image
Note 1
watermarkProperties - XML instructions file describing the watermark to be applied to the requested document.
The XML file must conform to the transformation-instruction-set.xsd schema (sample).

watermarkName - Pre-Configured Watermark stored with CommandCenter.
includeHistoryReport Whether or not to return the name of the document history.

Note 1: Either a watermarkProperties or a watermarkName may be passed in. A watermarkProperties will be applied before a watemarkName and a watemarkName will be applied before preconfigured rules defined with CommandCenter. If none of these are found, a default vault watermark will be applied.

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.