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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Documents

Namespace Global

    Namespace Field2Office.API.Model.Documents

        '''<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>
        Public Partial Class DocumentEmail
            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property Recipient As String
            Public Overridable Property UsePdf As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET 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