SelectGenerateDeliver
Overview
The SelectGenerateDeliver operation is used to select documents, generate images, and then pass to the delivery service to be delivered to the recipients specified on the request. This operation is a synchronous 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.
| Operation | SelectGenerateDeliver |
|---|---|
| Style | document |
| Operation Type | Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action | http://www.wolterskluwerfs.com/2014/05/DocServices/V2/IEDocService/SelectGenerateDeliver |
| Input | IEDocService_SelectGenerateDeliver_InputMessage (soap:body, use = literal) parameters type SelectGenerateDeliver |
| Output | IEDocService_SelectGenerateDeliver_OutputMessage (soap:body, use = literal) parameters type SelectGenerateDeliver |
Request Message
The operation input is SelectGenerateDeliver. The request requires a SelectGenerateDeliver object.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| request | SelectGenerateDeliverIn | Required | An object to hold data on what documents to select, generate and deliver. |
Response Element
The operation output is SelectGenerateDeliverResponse. The response returns a SelectGenerateDeliverOut object containing status information for the request.
| Element | Name | Description |
|---|---|---|
| SelectGenerateDeliverResponse | SelectGenerateDeliverResult | The output message for the SelectGenerateDeliverResponse operation used to facilitate the select, generate, and delivery process. |
Request and Response Samples
For sample code, see: SelectGenerateDeliver.