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

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