Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication 
import Foundation
import ServiceStack

/**
* Inserts a communication that is not already saved.
*/
// @Api(Description="Inserts a communication that is not already saved.")
public class SaveCommunication : ISubscription, Codable
{
    /**
    * 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 var suiteDataSourceInstanceId:String

    /**
    * 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 var alternateKey:String

    /**
    * 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 var objectId:String

    public var ignoreValidation:Bool
    /**
    * Communication Status Id.
    */
    // @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
    public var communicationStatusId:String

    /**
    * 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 var communicationXml:String

    /**
    * 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 var objectIdPrepositional:String

    required public init(){}
}

Swift SaveCommunication DTOs

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

HTTP + OTHER

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

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

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

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

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