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.*


/**
* 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 .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"}