<back to all web services
DocumentEmailTemplate
Represents the email output configuration for a single document template.
The following routes are available for this service:| GET,POST,DELETE | /{Workspace}/DocumentTemplate/{Type}/Email | | |
|---|
DocumentEmailTemplate Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Type | path | string | No | |
| Workspace | path | string | No | |
| Engine | body | EmailOutputEngine | No | |
| Format | body | EmailOutputFormat | No | |
| PdfTemplate | body | string | No | |
| BodyTemplate | body | string | No | |
| SubjectTemplate | body | string | No | |
| HeaderTemplate | body | string | No | |
| FooterTemplate | body | string | No | |
| PageSize | body | string | No | |
| Orientation | body | string | No | |
| Margins | body | string | No | |
EmailOutputEngine Enum:| DefaultHtml | |
| DefaultPdf | |
| Custom | |
| Standard | |
EmailOutputFormat Enum:| Embed | |
| AttachPdf | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /{Workspace}/DocumentTemplate/{Type}/Email HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DocumentEmailTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Documents">
<BodyTemplate>String</BodyTemplate>
<Engine>DefaultHtml</Engine>
<FooterTemplate>String</FooterTemplate>
<Format>Embed</Format>
<HeaderTemplate>String</HeaderTemplate>
<Margins>String</Margins>
<Orientation>String</Orientation>
<PageSize>String</PageSize>
<PdfTemplate>String</PdfTemplate>
<SubjectTemplate>String</SubjectTemplate>
<Type>String</Type>
<Workspace>String</Workspace>
</DocumentEmailTemplate>