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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Documents;
using Field2Office.DomainObjects;

namespace Field2Office.API.Model.Documents
{
    ///<summary>
    ///Represents the email output configuration for a single document template.
    ///</summary>
    public partial class DocumentEmailTemplate
    {
        public virtual string Type { get; set; }
        public virtual string Workspace { get; set; }
        public virtual EmailOutputEngine Engine { get; set; }
        public virtual EmailOutputFormat Format { get; set; }
        public virtual string PdfTemplate { get; set; }
        public virtual string BodyTemplate { get; set; }
        public virtual string SubjectTemplate { get; set; }
        public virtual string HeaderTemplate { get; set; }
        public virtual string FooterTemplate { get; set; }
        public virtual string PageSize { get; set; }
        public virtual string Orientation { get; set; }
        public virtual string Margins { get; set; }
    }

}

namespace Field2Office.DomainObjects
{
    public enum EmailOutputEngine
    {
        DefaultHtml,
        DefaultPdf,
        Custom,
        Standard,
    }

    public enum EmailOutputFormat
    {
        Embed,
        AttachPdf,
    }

}

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