Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

Namespace Global

    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
            Implements 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 Overridable Property SuiteDataSourceInstanceId As Guid Implements ISubscription.SuiteDataSourceInstanceId

            '''<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 Overridable Property AlternateKey As String Implements ISubscription.AlternateKey

            '''<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 Overridable Property ObjectId As Guid Implements ISubscription.ObjectId

            Public Overridable Property IgnoreValidation As Boolean Implements ISubscription.IgnoreValidation
            '''<Summary>
            '''Communication Status Id.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Communication Status Id.", IsRequired:=true, Name:="CommunicationStatusId", ParameterType:="query")>
            Public Overridable Property CommunicationStatusId As Guid

            '''<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 Overridable Property CommunicationXml As String

            '''<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 Overridable Property ObjectIdPrepositional As Guid
        End Class
    End Namespace
End Namespace

VB.NET 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
	}
}