Platform Subscription API

SaveCommunication

Inserts a communication that is not already saved.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<summary>
    ///Inserts a communication that is not already saved.
    ///</summary>
    [Api(Description="Inserts a communication that is not already saved.")]
    public partial class SaveCommunication
        : ISubscription
    {
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///The unique key that represents the communication on the external system.
        ///</summary>
        [ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")]
        public virtual string AlternateKey { get; set; }

        ///<summary>
        ///Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
        ///</summary>
        [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 virtual Guid ObjectId { get; set; }

        public virtual bool IgnoreValidation { get; set; }
        ///<summary>
        ///Communication Status Id.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")]
        public virtual Guid CommunicationStatusId { get; set; }

        ///<summary>
        ///XML containing the content of the communication.
        ///</summary>
        [ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")]
        public virtual string CommunicationXml { get; set; }

        ///<summary>
        ///Guid of the object this communication is related to.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")]
        public virtual Guid ObjectIdPrepositional { get; set; }
    }

}

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