Platform Subscription API

SaveCommunication

Inserts a communication that is not already saved.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Inserts a communication that is not already saved.
*/
@Api(Description="Inserts a communication that is not already saved.")
open class SaveCommunication : 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")
    override var SuiteDataSourceInstanceId:UUID? = 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")
    override var AlternateKey:String? = 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")
    override var ObjectId:UUID? = null

    override var IgnoreValidation:Boolean? = null
    /**
    * Communication Status Id.
    */
    @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
    open var CommunicationStatusId:UUID? = 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")
    open var CommunicationXml:String? = 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")
    open var ObjectIdPrepositional:UUID? = null
}

Kotlin SaveCommunication DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"AlternateKey":"String","IgnoreValidation":false,"CommunicationXml":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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