GET api/MailMerge/GetMailMergedWordDocument?businessModuleID={businessModuleID}&entityID={entityID}&templateID={templateID}&includeHtml={includeHtml}&includeBytes={includeBytes}&commonFieldsBusinessModuleID={commonFieldsBusinessModuleID}&commonFieldsEntityID={commonFieldsEntityID}
Creates a Word document based on a template and returns the document
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| businessModuleID |
The business module id of the entity |
globally unique identifier |
Required |
| entityID |
The entity id |
integer |
Required |
| templateID |
The Word template id |
integer |
Required |
| includeHtml |
Include the document as HTML in the result |
boolean |
Required |
| includeBytes |
Include the document as a byte array in the result |
boolean |
Required |
| commonFieldsBusinessModuleID |
The business module id of the common field source |
globally unique identifier |
None. |
| commonFieldsEntityID |
The entity id of the common field source |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns a Word document
WorkPoint365.WebAPI.Model.MailMergeDocumentResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Html |
Gets or sets the HTML. |
string |
None. |
| Bytes |
Gets or sets the Bytes. |
Collection of byte |
None. |
| FileName |
Gets or sets the FileName. |
string |
None. |
| Subject |
Gets or sets the Subject. |
string |
None. |
| ErrorMessages |
Gets or sets the error messages. |
Collection of string |
None. |
| Ok |
Gets a value indicating whether this |
boolean |
None. |
Response Formats
application/json, text/json
Sample not available.