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 Foundation
import ServiceStack

/**
* Represents the email output configuration for a single document template.
*/
public class DocumentEmailTemplate : Codable
{
    public var type:String
    public var workspace:String
    public var engine:EmailOutputEngine
    public var format:EmailOutputFormat
    public var pdfTemplate:String
    public var bodyTemplate:String
    public var subjectTemplate:String
    public var headerTemplate:String
    public var footerTemplate:String
    public var pageSize:String
    public var orientation:String
    public var margins:String

    required public init(){}
}

public enum EmailOutputEngine : String, Codable
{
    case DefaultHtml
    case DefaultPdf
    case Custom
    case Standard
}

public enum EmailOutputFormat : String, Codable
{
    case Embed
    case AttachPdf
}


Swift 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
}