eoVoidDocument
Action Parameter
eoVoidDocument
Purpose
To delete an old document. Upload a new document and link the two.
Description
Type
Coarse
Preconditions
A transaction has been created, and the client application has the transactionSid as well as the dptName.
Implementation Notes
The eoVoidDocument API call replaces an API workflow series of eoRequestDestruction, eoAuthorizeDestruction, eoCreateDocumentProfile, eoUploadDocument.
Parameters
Required
Parameter
Value
Description
dpSid
Sequence ID (SID) of the document to destroy.
Note 1
retention
none
eCopy
Keep a retention copy?
Note 1
watermarkProperties
watermarkName
watermarkProperties - XML instructions file describing the watermark to a retention copy.
The XML file must conform to the
transformation-instruction-set.xsd schema
(
sample
).
watermarkName - Pre-Configured Watermark stored with CommandCenter.
dptName
Name of the document profile template (DPT) used to create the document profile
dpName
Document profile name of the document to be signed
dpStateName
Document profile's state name after it is created. If this parameter is not passed, the default is the eCore® default state.
srcFile
The PDF file to be stored.
documentFileName
The filename of the srcFile. This parameter is used when the document is rendered from the eCore® service, and should include the .PDF document extension in the parameter.
mimeType
application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
text/plain
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/lotus123
text/comma-separated-values
text/csv
application/csv
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
image/bmp
image/jpeg
application/postscript
application/png
image/png
application/x-png
image/tiff
image/gif
image/x-xbitmap
The document mime/type
applyStoredFormFieldsTemplate
false
true
This merge form fields that are attached to a DPT when the document is stored.
Note 1: A watermark will only be used if a retention copy is kept.
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.