Field Squared API Services

DocumentEmail

Email the specified document to a customer via a supplied email. Separate multiple recipient email addresses by ','.
To override the 'from' email address, specify the query parameter fromaddress=joe@mycompany.com.
To override the 'from' name, specify the query parameter fromname=Joe Smith.

The following routes are available for this service:
GET	/{Workspace}/Email/Document/{ObjectId}
GET	/{Workspace}/Email/Document/{ObjectId}/{Recipient}

import 'package:servicestack/servicestack.dart';

/**
* Email the specified document to a customer via a supplied email.  Separate multiple recipient email addresses by ','.  To override the 'from' email address, specify the query parameter fromaddress=joe@mycompany.com.  To override the 'from' name, specify the query parameter fromname=Joe Smith.  
*/
class DocumentEmail implements IConvertible
{
    String? Workspace;
    String? ObjectId;
    String? Recipient;
    bool? UsePdf;

    DocumentEmail({this.Workspace,this.ObjectId,this.Recipient,this.UsePdf});
    DocumentEmail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        ObjectId = json['ObjectId'];
        Recipient = json['Recipient'];
        UsePdf = json['UsePdf'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'ObjectId': ObjectId,
        'Recipient': Recipient,
        'UsePdf': UsePdf
    };

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

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'DocumentEmail': TypeInfo(TypeOf.Class, create:() => DocumentEmail()),
});

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

GET /{Workspace}/Email/Document/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml