Trendsic Platform Service

<back to all web services

MassCommunicationContactRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/MassCommunicationContact
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class MassCommunicationContactRequest
    {
        public String Subject = null;
        public String Message = null;
        public ArrayList<String> Recipients = new ArrayList<String>();
        public ArrayList<String> Locations = new ArrayList<String>();
        public Boolean EmailMissingNumbers = null;
        public Boolean EmailAll = null;
        public Boolean SMSAll = null;
        public String ContactCategories = null;
        
        public String getSubject() { return Subject; }
        public MassCommunicationContactRequest setSubject(String value) { this.Subject = value; return this; }
        public String getMessage() { return Message; }
        public MassCommunicationContactRequest setMessage(String value) { this.Message = value; return this; }
        public ArrayList<String> getRecipients() { return Recipients; }
        public MassCommunicationContactRequest setRecipients(ArrayList<String> value) { this.Recipients = value; return this; }
        public ArrayList<String> getLocations() { return Locations; }
        public MassCommunicationContactRequest setLocations(ArrayList<String> value) { this.Locations = value; return this; }
        public Boolean isEmailMissingNumbers() { return EmailMissingNumbers; }
        public MassCommunicationContactRequest setEmailMissingNumbers(Boolean value) { this.EmailMissingNumbers = value; return this; }
        public Boolean isEmailAll() { return EmailAll; }
        public MassCommunicationContactRequest setEmailAll(Boolean value) { this.EmailAll = value; return this; }
        public Boolean isSmsAll() { return SMSAll; }
        public MassCommunicationContactRequest setSmsAll(Boolean value) { this.SMSAll = value; return this; }
        public String getContactCategories() { return ContactCategories; }
        public MassCommunicationContactRequest setContactCategories(String value) { this.ContactCategories = value; return this; }
    }

    public static class MassCommunicationResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Boolean Success = null;
        public Integer Recipients = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public MassCommunicationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Boolean isSuccess() { return Success; }
        public MassCommunicationResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public Integer getRecipients() { return Recipients; }
        public MassCommunicationResponse setRecipients(Integer value) { this.Recipients = value; return this; }
    }

}

Java MassCommunicationContactRequest 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.

POST /v1/MassCommunicationContact HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MassCommunicationContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactCategories>String</ContactCategories>
  <EmailAll>false</EmailAll>
  <EmailMissingNumbers>false</EmailMissingNumbers>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Locations>
  <Message>String</Message>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Recipients>
  <SMSAll>false</SMSAll>
  <Subject>String</Subject>
</MassCommunicationContactRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MassCommunicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Recipients>0</Recipients>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success>false</Success>
</MassCommunicationResponse>