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

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 virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string Recipient { get; set; }
        public virtual bool? UsePdf { get; set; }
    }

}

C# 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