SelectAndGenerate
Overview
The SelectAndGenerate operation is used to request documents based on a given transaction defined in the request.
This operation is an asynchronous call back that takes a Content URI and a unique ID (ticket #) for the calling application and returns a package(s) as requested by the calling application. The operation is used to request processing of all documents for a specified package, including options for 1) generating a text watermark, 2) generating documents as a merged output file or individual files, and 3) assigning a specific barcode format. This is typically followed by a call to the GetRequestResult operation to return the generated package documents as requested by the calling application in the SelectAndGenerate request.
| Operation | SelectAndGenerate |
|---|---|
| Style | document |
| Operation Type | Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action | http://www.wolterskluwerfs.com/2012/12/DocGenServices/IDocumentService/SelectAndGenerate |
| Input | SelectAndGenerate_InputMessage (soap:body, use = literal) parameterstype SelectAndGenerateRequest |
| Output | SelectAndGenerate_OutputMessage (soap:body, use = literal) parameters type SelectAndGenerateResponse |
Request Message
The operation input is SelectAndGenerateRequest. The request (request) requires a SelectAndGenerateRequest object containing a request identifier (RequestID) as a parameter on the input.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| request | SelectAndGenerateRequest | Required | The input message for the SelectAndGenerate operation. |
Response Element
The operation output is SelectAndGenerateResponse. The response returns a SelectAndGenerateResponse object containing status information for the request.
| Element | Name | Description |
|---|---|---|
| SelectAndGenerateResponse | SelectAndGenerateResult | The output message for the SelectAndGenerate operation. |
Request and Response Samples
For sample code, see: SelectAndGenerate.