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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Represents the email output configuration for a single document template.
    */
    public static class DocumentEmailTemplate
    {
        public String Type = null;
        public String Workspace = null;
        public EmailOutputEngine Engine = null;
        public EmailOutputFormat Format = null;
        public String PdfTemplate = null;
        public String BodyTemplate = null;
        public String SubjectTemplate = null;
        public String HeaderTemplate = null;
        public String FooterTemplate = null;
        public String PageSize = null;
        public String Orientation = null;
        public String Margins = null;
        
        public String getType() { return Type; }
        public DocumentEmailTemplate setType(String value) { this.Type = value; return this; }
        public String getWorkspace() { return Workspace; }
        public DocumentEmailTemplate setWorkspace(String value) { this.Workspace = value; return this; }
        public EmailOutputEngine getEngine() { return Engine; }
        public DocumentEmailTemplate setEngine(EmailOutputEngine value) { this.Engine = value; return this; }
        public EmailOutputFormat getFormat() { return Format; }
        public DocumentEmailTemplate setFormat(EmailOutputFormat value) { this.Format = value; return this; }
        public String getPdfTemplate() { return PdfTemplate; }
        public DocumentEmailTemplate setPdfTemplate(String value) { this.PdfTemplate = value; return this; }
        public String getBodyTemplate() { return BodyTemplate; }
        public DocumentEmailTemplate setBodyTemplate(String value) { this.BodyTemplate = value; return this; }
        public String getSubjectTemplate() { return SubjectTemplate; }
        public DocumentEmailTemplate setSubjectTemplate(String value) { this.SubjectTemplate = value; return this; }
        public String getHeaderTemplate() { return HeaderTemplate; }
        public DocumentEmailTemplate setHeaderTemplate(String value) { this.HeaderTemplate = value; return this; }
        public String getFooterTemplate() { return FooterTemplate; }
        public DocumentEmailTemplate setFooterTemplate(String value) { this.FooterTemplate = value; return this; }
        public String getPageSize() { return PageSize; }
        public DocumentEmailTemplate setPageSize(String value) { this.PageSize = value; return this; }
        public String getOrientation() { return Orientation; }
        public DocumentEmailTemplate setOrientation(String value) { this.Orientation = value; return this; }
        public String getMargins() { return Margins; }
        public DocumentEmailTemplate setMargins(String value) { this.Margins = value; return this; }
    }

    public static enum EmailOutputEngine
    {
        DefaultHtml,
        DefaultPdf,
        Custom,
        Standard;
    }

    public static enum EmailOutputFormat
    {
        Embed,
        AttachPdf;
    }

}

Java DocumentEmailTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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
}