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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Documents
Imports Field2Office.DomainObjects

Namespace Global

    Namespace Field2Office.API.Model.Documents

        '''<Summary>
        '''Represents the email output configuration for a single document template.
        '''</Summary>
        Public Partial Class DocumentEmailTemplate
            Public Overridable Property Type As String
            Public Overridable Property Workspace As String
            Public Overridable Property Engine As EmailOutputEngine
            Public Overridable Property Format As EmailOutputFormat
            Public Overridable Property PdfTemplate As String
            Public Overridable Property BodyTemplate As String
            Public Overridable Property SubjectTemplate As String
            Public Overridable Property HeaderTemplate As String
            Public Overridable Property FooterTemplate As String
            Public Overridable Property PageSize As String
            Public Overridable Property Orientation As String
            Public Overridable Property Margins As String
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects

        Public Enum EmailOutputEngine
            DefaultHtml
            DefaultPdf
            Custom
            Standard
        End Enum

        Public Enum EmailOutputFormat
            Embed
            AttachPdf
        End Enum
    End Namespace
End Namespace

VB.NET 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
}