Field Squared API Services

<back to all web 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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.  
    */
    public static class DocumentEmail
    {
        public String Workspace = null;
        public String ObjectId = null;
        public String Recipient = null;
        public Boolean UsePdf = null;
        
        public String getWorkspace() { return Workspace; }
        public DocumentEmail setWorkspace(String value) { this.Workspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public DocumentEmail setObjectId(String value) { this.ObjectId = value; return this; }
        public String getRecipient() { return Recipient; }
        public DocumentEmail setRecipient(String value) { this.Recipient = value; return this; }
        public Boolean isUsePdf() { return UsePdf; }
        public DocumentEmail setUsePdf(Boolean value) { this.UsePdf = value; return this; }
    }

}

Java 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