Field Squared API 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


export enum EmailOutputEngine
{
    DefaultHtml = 'DefaultHtml',
    DefaultPdf = 'DefaultPdf',
    Custom = 'Custom',
    Standard = 'Standard',
}

export enum EmailOutputFormat
{
    Embed = 'Embed',
    AttachPdf = 'AttachPdf',
}

/** @description Represents the email output configuration for a single document template. */
export class DocumentEmailTemplate
{
    public Type: string;
    public Workspace: string;
    public Engine: EmailOutputEngine;
    public Format: EmailOutputFormat;
    public PdfTemplate: string;
    public BodyTemplate: string;
    public SubjectTemplate: string;
    public HeaderTemplate: string;
    public FooterTemplate: string;
    public PageSize: string;
    public Orientation: string;
    public Margins: string;

    public constructor(init?: Partial<DocumentEmailTemplate>) { (Object as any).assign(this, init); }
}

TypeScript DocumentEmailTemplate DTOs

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>