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
namespace Field2Office.API.Model.Documents

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type EmailOutputEngine =
        | DefaultHtml = 0
        | DefaultPdf = 1
        | Custom = 2
        | Standard = 3

    type EmailOutputFormat =
        | Embed = 0
        | AttachPdf = 1

    ///<summary>
    ///Represents the email output configuration for a single document template.
    ///</summary>
    [<AllowNullLiteral>]
    type DocumentEmailTemplate() = 
        member val Type:String = null with get,set
        member val Workspace:String = null with get,set
        member val Engine:EmailOutputEngine = new EmailOutputEngine() with get,set
        member val Format:EmailOutputFormat = new EmailOutputFormat() with get,set
        member val PdfTemplate:String = null with get,set
        member val BodyTemplate:String = null with get,set
        member val SubjectTemplate:String = null with get,set
        member val HeaderTemplate:String = null with get,set
        member val FooterTemplate:String = null with get,set
        member val PageSize:String = null with get,set
        member val Orientation:String = null with get,set
        member val Margins:String = null with get,set

F# 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>