Field Squared API Services

<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

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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Type":"String","Workspace":"String","Engine":"DefaultHtml","Format":"Embed","PdfTemplate":"String","BodyTemplate":"String","SubjectTemplate":"String","HeaderTemplate":"String","FooterTemplate":"String","PageSize":"String","Orientation":"String","Margins":"String"}