GenerateRequest
The GenerateRequest object is submitted as part of the Generate request message (input). The message requires the transaction data and information describing the requested transaction.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| TransactionData | sequence | Required | Transaction data in the form of a XML file, confirming to the ExpereTxn schema, used to process the request. |
| ContentIdentifier | string | Required | Defines the type of content to be used.A string of characters used to identify a system resource. In this implementation, the value should reflect the fully qualified URL used as the recipient of a response (the callback URI) after the document has been generated. The callback is submitted without security parameters. |
| CallbackUri | string | Required | A string of characters used to identify a system resource. In this implementation, the value should reflect the fully qualified URL used as the recipient of a response (the callback URI) after the document has been generated. The callback is submitted without security parameters. |
| AccountID | string | Required | A unique identifier for the account associated with the request. This is assigned as part of an account's administration setup process. |
| ProductType | string | Required | The type of the product associated with the instance. |
| IdentityId | string | Required | An identifier for the entity associated with the generated documents submitted on the transaction data. |
| ExternalKey | string | Required | An identifier defined by the requesting application and passed as a string value. It is typically used to supply an identifier or reference value for a given request and is mapped to the RequestID. |
| RequestID | string | Required | A unique identifier for the submitted request. Often used for request tracking purposes. |
| DocumentFormat | DocumentFormatType | Required | Object defining the format type for a document (based on an enumerated value). |
| DynamicPdfRender | DynamicPdfRender | Required | Object defining the rendering option for a document (based on an enumerated value). |
| DocumentSet | ArrayOfDocument | Required | Array containing an unbound collection of Document objects. |
| AncillaryOutput | ArrayOfAncillaryOutputOption | Required | Array containing an unbound collection of AncillaryOutputOption objects. |
| ExternalPDFDocuments | ExternalPDFDocuments | Required | Container object used to pass base64 encoded PDF documents. |
| DaysToPersistInLongTermStorage | integer | Optional | The value used to calculate when the request will be deleted from the database (in days). Setting a value of "-1" will immediately delete all request data and images. "7" is the default value. |
| NotificationType | string | Optional | Notification that documents have been posted to the document rendering engine as well as document status. |
| Callback | Callback | Optional | Object defining the contenturi and authentication parameters. |
| MergeTRIDDocs | Boolean | Optional | True or false indicator. |
| InlinePackage | NA | Optional | Used to pass in inline package transaction .XML data in the
<InlinePackage/> element. |
| EZConfig | EZConfig | Optional | Container object for EZConfigID information. |
| NoPublish | Boolean | Yes or Not indicator determining whether or not to publish | |
| EZTransform | EZTransform | Container object for EZTransform information. |