Documents

The Documents object contains information about a document, specifically the DocumentID, Format, AncillaryOutput and DisplayName.

Parameter Type Description
DocumentID string A string of data representing the Document ID
StoredDocID string A string of data representing the Stored Document ID.
OrganizationID string A string of data representing the Organization ID
InstanceID string A string of data representing the Instance ID
InstanceBarcodeValue string A string of data representing the Instance Barcode Value
Format DocumentFormatType A scope object that can be submitted to define a document format type based on enumerated values.
InstanceFileName string Gets or Sets InstanceFileName
PageCount integer A numeric value representing the amount of pages in the document.
AncillaryOutput AncillaryOutputOption A set of objects that can be submitted to define an output type as requiring a watermark, barcode, or encryption
Type boolean Indicates either a dynamic or static document
FragmentName string A string of data representing the fragment name
Autoselected boolean Indicates whether or not the document was autoselected.
Format string Indicates the document format
Data Data Contains the transaction data inputs and outputs in binary (base64), text, or xml format
Suggested boolean Indicates whether the document was suggested or not.
Copy Integer The number of document copies
Order Integer The order of the documents; not typically used.
PackageID string A string of data representing the PackageID.

When using ListDocuments through Packages and Packets

When using the ListDocuments method with EZ Config Packages and Packets, certain elements will always return specific values; for example:

The following elements will return "null" values:

  • OrganizationID
  • InstanceID
  • InstanceBarcodeValue
  • InstanceFileName
  • FragmentName
  • Format
  • AncillaryOutputOptions
  • Data

The following elements will return "0" values:

  • PageCount
  • Copy

The Type element will always return a "Dynamic" value.