BeginSessionWithREQ (Input)
The BeginSessionWithREQ object is submitted as part of the BeginSessionWithREQ request message (input).
| Parameter | Type | Description |
|---|---|---|
| reqData | string | This is a string representation of actual .XML for the REQ file. It is not a path to the REQ file. |
| txn | string | This is the transaction data in a specific XML format. This parameter is optional for this service call. If it is not provided, the first transaction within the REQ file will be used. |
| overrideDictionary | string | This is the string contents of an overlay dictionary you want to apply to the REQ file. In the normal BeginSession service call, just the name of the dictionary is provided and it is then loaded from the repository. In this service call you need to provide the entire xml string of the dictionary. |
| emitDebugInfo | boolean | Turn debug information on or off. Set to True to enable debug information within the documents. Set to False to replicate a production view of the REQ content. If not provided, it will be set to False. |
| redirectOnCompletionUrl | string | This is the URL that DocViewer Interface should navigate to when the user completes the DocViewer interaction. The URL used should also include a query string in the format ?SessionId=<SESSION_ID>. DocViewer will replace <SESSION_ID> with the actual ID of the session so that your URL can take action on it. |
| options | configuration | This argument is used to specify a variety of UI configuration options. UI customization items include, but are not limited to, the visibility of certain elements and the coloring of certain elements. In addition to UI customization, the option to specify a pre-selected package is available as well as the option to specify a list of xpaths. |