| GET,POST,DELETE | /{Workspace}/DocumentTemplate/{Type}/Email |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class EmailOutputEngine(str, Enum):
DEFAULT_HTML = 'DefaultHtml'
DEFAULT_PDF = 'DefaultPdf'
CUSTOM = 'Custom'
STANDARD = 'Standard'
class EmailOutputFormat(str, Enum):
EMBED = 'Embed'
ATTACH_PDF = 'AttachPdf'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentEmailTemplate:
"""
Represents the email output configuration for a single document template.
"""
type: Optional[str] = None
workspace: Optional[str] = None
engine: Optional[EmailOutputEngine] = None
format: Optional[EmailOutputFormat] = None
pdf_template: Optional[str] = None
body_template: Optional[str] = None
subject_template: Optional[str] = None
header_template: Optional[str] = None
footer_template: Optional[str] = None
page_size: Optional[str] = None
orientation: Optional[str] = None
margins: Optional[str] = None
Python DocumentEmailTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>