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

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents the email output configuration for a single document template.
*/
open class DocumentEmailTemplate
{
    var Type:String? = null
    var Workspace:String? = null
    var Engine:EmailOutputEngine? = null
    var Format:EmailOutputFormat? = null
    var PdfTemplate:String? = null
    var BodyTemplate:String? = null
    var SubjectTemplate:String? = null
    var HeaderTemplate:String? = null
    var FooterTemplate:String? = null
    var PageSize:String? = null
    var Orientation:String? = null
    var Margins:String? = null
}

enum class EmailOutputEngine
{
    DefaultHtml,
    DefaultPdf,
    Custom,
    Standard,
}

enum class EmailOutputFormat
{
    Embed,
    AttachPdf,
}

Kotlin 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>