Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Inserts a communication that is not already saved.
    */
    @Api(Description="Inserts a communication that is not already saved.")
    public static class SaveCommunication implements ISubscription
    {
        /**
        * Guid representing the external systems datasource information.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * The unique key that represents the communication on the external system.
        */
        @ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")
        public String AlternateKey = null;

        /**
        * Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
        */
        @ApiMember(DataType="Guid", Description="Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.", IsRequired=true, Name="ObjectId", ParameterType="query")
        public UUID ObjectId = null;

        public Boolean IgnoreValidation = null;
        /**
        * Communication Status Id.
        */
        @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
        public UUID CommunicationStatusId = null;

        /**
        * XML containing the content of the communication.
        */
        @ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")
        public String CommunicationXml = null;

        /**
        * Guid of the object this communication is related to.
        */
        @ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")
        public UUID ObjectIdPrepositional = null;
        
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public SaveCommunication setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public SaveCommunication setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public SaveCommunication setObjectId(UUID value) { this.ObjectId = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public SaveCommunication setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
        public UUID getCommunicationStatusId() { return CommunicationStatusId; }
        public SaveCommunication setCommunicationStatusId(UUID value) { this.CommunicationStatusId = value; return this; }
        public String getCommunicationXml() { return CommunicationXml; }
        public SaveCommunication setCommunicationXml(String value) { this.CommunicationXml = value; return this; }
        public UUID getObjectIdPrepositional() { return ObjectIdPrepositional; }
        public SaveCommunication setObjectIdPrepositional(UUID value) { this.ObjectIdPrepositional = value; return this; }
    }

}

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

POST /jsv/reply/SaveCommunication HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AlternateKey: String,
	IgnoreValidation: False,
	CommunicationXml: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}