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 'package:servicestack/servicestack.dart';

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

enum EmailOutputFormat
{
    Embed,
    AttachPdf,
}

/**
* Represents the email output configuration for a single document template.
*/
class DocumentEmailTemplate implements IConvertible
{
    String? Type;
    String? Workspace;
    EmailOutputEngine? Engine;
    EmailOutputFormat? Format;
    String? PdfTemplate;
    String? BodyTemplate;
    String? SubjectTemplate;
    String? HeaderTemplate;
    String? FooterTemplate;
    String? PageSize;
    String? Orientation;
    String? Margins;

    DocumentEmailTemplate({this.Type,this.Workspace,this.Engine,this.Format,this.PdfTemplate,this.BodyTemplate,this.SubjectTemplate,this.HeaderTemplate,this.FooterTemplate,this.PageSize,this.Orientation,this.Margins});
    DocumentEmailTemplate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Type = json['Type'];
        Workspace = json['Workspace'];
        Engine = JsonConverters.fromJson(json['Engine'],'EmailOutputEngine',context!);
        Format = JsonConverters.fromJson(json['Format'],'EmailOutputFormat',context!);
        PdfTemplate = json['PdfTemplate'];
        BodyTemplate = json['BodyTemplate'];
        SubjectTemplate = json['SubjectTemplate'];
        HeaderTemplate = json['HeaderTemplate'];
        FooterTemplate = json['FooterTemplate'];
        PageSize = json['PageSize'];
        Orientation = json['Orientation'];
        Margins = json['Margins'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Type': Type,
        'Workspace': Workspace,
        'Engine': JsonConverters.toJson(Engine,'EmailOutputEngine',context!),
        'Format': JsonConverters.toJson(Format,'EmailOutputFormat',context!),
        'PdfTemplate': PdfTemplate,
        'BodyTemplate': BodyTemplate,
        'SubjectTemplate': SubjectTemplate,
        'HeaderTemplate': HeaderTemplate,
        'FooterTemplate': FooterTemplate,
        'PageSize': PageSize,
        'Orientation': Orientation,
        'Margins': Margins
    };

    getTypeName() => "DocumentEmailTemplate";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'EmailOutputEngine': TypeInfo(TypeOf.Enum, enumValues:EmailOutputEngine.values),
    'EmailOutputFormat': TypeInfo(TypeOf.Enum, enumValues:EmailOutputFormat.values),
    'DocumentEmailTemplate': TypeInfo(TypeOf.Class, create:() => DocumentEmailTemplate()),
});

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