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}
namespace Field2Office.API.Model.Documents

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///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.  
    ///</summary>
    [<AllowNullLiteral>]
    type DocumentEmail() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val Recipient:String = null with get,set
        member val UsePdf:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# DocumentEmail DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv