eoSearchDocuments
Action Parameter
eoSearchDocuments
Purpose
To locate documents based on provided search criteria
Description
All documents that contain the desired information are be returned
Type
Granular
Preconditions
None
Parameters
Required
Parameter
Value
Description
documentName
String to be used as the document's ID value
documentXRef1
Cross-reference value for document
documentXRef2
Cross-reference value for document
documentXRef3
Cross-reference value for document
documentStateName
The status of the desired document
documentProfileTemplateName
The DPT of the desired document
createStartDate
Date and time to begin the search; createStartDate must be formatted like the following: ddMMyyyy HH:mm:ss
createEndDate
Date and time to end the search; createEndDate must be formatted like the following: ddMMyyyy HH:mm:ss
expirationStartDate
Date and time to begin the search; expirationStartDate must be formatted like the following: ddMMyyyy HH:mm:ss
expirationEndDate
Date and time to end the search; expirationEndDate must be formatted like the following: ddMMyyyy HH:mm:ss
offset
maxDisplay
The maximum number of results to return. The default is 1,000,000 and values larger than 1,000,000 will be ignored.
locked
true
false
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.