Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Inserts a communication that is not already saved.
    ///</summary>
    [<Api(Description="Inserts a communication that is not already saved.")>]
    [<AllowNullLiteral>]
    type SaveCommunication() = 
        ///<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")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with 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")>]
        member val AlternateKey:String = null with 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")>]
        member val ObjectId:Guid = new Guid() with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set
        ///<summary>
        ///Communication Status Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")>]
        member val CommunicationStatusId:Guid = new Guid() with 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")>]
        member val CommunicationXml:String = null with 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")>]
        member val ObjectIdPrepositional:Guid = new Guid() with get,set

F# 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
	}
}