Jump to main content

# GenerateRequest

The operation input is GenerateRequest. The input message for the Generate operation used to request processing of a specified package.

Parameter | Type | Constraints | Description
--- | --- | --- | ---
Transaction | Transaction | Required | A container for transaction information as a transaction identifier (TransactionID).
Organization | Organization | Optional | Container for storing information about the Organization.
RequestID | string | Optional | A unique identifier for the submitted request. Often used for request tracking purposes.
Policy | Policy | Optional | A container for policy information. Policy is not required but can be used to enable dynamic setup data. This policy refers to ERL policies.
PackageID | string | Required | The name of the document selection package as it exists in the database. The value reflects the document selection package ID as a string and may not be submitted if an LOBPhase is submitted..
LOBPhase | LOBPhase | Required | A container for Line of Business information. Do not submit if a PackageID is submitted.
InlinePackage | InlinePackage | Optional | Specifies which PackageDocs and Packets apply to the request. The Expere-generated default package will be placed at the end of the Inline package order.
DocumentSet | ArrayOfDocument | Required | Array containing an unbound collection of DocumentSet objects.
DocumentFormat | DocumentFormatType | Optional | Object defining the format type for a document (based on an enumerated value): PDF specifies that output documents should be formatted as PDF.; RAW_XML specifies that output documents should be formatted as XML.; RTF specifies that output documents should be formatted as RTF (dynamic documents output as RTF, however static docs output as fillable PDFs).
AncillaryOutput | ArrayOfAncillaryOutputOption | Optional | Array containing an unbound collection of AncillaryOutputOption objects.The AncillaryOuputOption is a flag to indicate details about how a document is rendered (for example, to apply watermarks or tamperseals).
ExternalPDFDocuments | ExternalPDFDocuments | Optional | Container object used to pass base64 encoded PDF documents.
MergeTRIDDocs | boolean | Optional | Element that allows users to merge TRID documents through the request file.

## Element tns:GenerateRequest

    <xs:element name="GenerateRequest">
    		<xs:annotation>
    			<xs:documentation>Root for the Generate API call</xs:documentation>
    		</xs:annotation>
    		<xs:complexType>
    			<xs:sequence>
    				<xs:element name="Transaction">
    					<xs:annotation>
    						<xs:documentation>A container for transaction information.</xs:documentation>
    					</xs:annotation>
    					<xs:complexType>
    						<xs:choice>
    							<xs:annotation>
    								<xs:documentation>Pass in either the TransactionID or the actual transaction data.</xs:documentation>
    							</xs:annotation>
    							<xs:element ref="TransactionID"/>
    							<xs:element name="Data">
    								<xs:annotation>
    									<xs:documentation>Contains the transaction data  conforming to the ExpereTxn schema.</xs:documentation>
    								</xs:annotation>
    								<xs:complexType>
    									<xs:sequence>
    										<xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
    									</xs:sequence>
    									<xs:anyAttribute/>
    								</xs:complexType>
    							</xs:element>
    						</xs:choice>
    					</xs:complexType>
    				</xs:element>
    				<xs:element ref="Organization" minOccurs="0"/>
    				<xs:element ref="RequestID" minOccurs="0"/>
    				<xs:element name="Policy" minOccurs="0">
    					<xs:annotation>
    						<xs:documentation>A container for policy information.  Policy is not required but can be used to enable dynamic setup data.</xs:documentation>
    					</xs:annotation>
    					<xs:complexType>
    						<xs:sequence>
    							<xs:element ref="PolicyID"/>
    						</xs:sequence>
    					</xs:complexType>
    				</xs:element>
    				<xs:element name="Oppsa" minOccurs="0">
    					<xs:annotation>
    						<xs:documentation>A container for OPPSA product information.  An OPPSA product is a set of policies produced by the Expere OPPSA Tool.</xs:documentation>
    					</xs:annotation>
    					<xs:complexType>
    						<xs:sequence>
    							<xs:element ref="OppsaOrganizationName"/>
    							<xs:element ref="OppsaProductName" minOccurs="0" maxOccurs="unbounded"/>
    						</xs:sequence>
    					</xs:complexType>
    				</xs:element>
    				<xs:choice minOccurs="0">
    					<xs:annotation>
    						<xs:documentation>Requires 1 of the child elements to be present.</xs:documentation>
    					</xs:annotation>
    					<xs:element ref="PackageID"/>
    					<xs:element ref="LOBPhase"/>
    					<xs:element ref="InlinePackage"/>
    				</xs:choice>
    				<xs:element name="DocumentSet">
    					<xs:annotation>
    						<xs:documentation>A container for information about a set of documents.</xs:documentation>
    						<xs:documentation>A container for documents.</xs:documentation>
    					</xs:annotation>
    					<xs:complexType>
    						<xs:sequence>
    							<xs:element name="Document" maxOccurs="unbounded">
    								<xs:annotation>
    									<xs:documentation>A container for information about a single document.</xs:documentation>
    								</xs:annotation>
    								<xs:complexType>
    									<xs:sequence>
    										<xs:element ref="DocumentID"/>
    										<xs:element ref="Format" minOccurs="0"/>
    										<xs:element ref="AncillaryOutput" minOccurs="0"/>
    									</xs:sequence>
    								</xs:complexType>
    							</xs:element>
    						</xs:sequence>
    					</xs:complexType>
    				</xs:element>
    				<xs:element ref="DocumentFormat" minOccurs="0"/>
    				<xs:element ref="MergeTRIDDocs" minOccurs="0"/>
    				<xs:element ref="AncillaryOutput" minOccurs="0" maxOccurs="unbounded"/>
    				<xs:element ref="ExternalPDFDocuments" minOccurs="0"/>
    			</xs:sequence>
    		</xs:complexType>
    	</xs:element>