Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Inserts a communication that is not already saved.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveCommunication(ISubscription):
    """
    Inserts a communication that is not already saved.
    """

    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the communication on the external system.
    """


    # @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")
    object_id: Optional[str] = None
    """
    Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
    """


    ignore_validation: bool = False
    # @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
    communication_status_id: Optional[str] = None
    """
    Communication Status Id.
    """


    # @ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")
    communication_xml: Optional[str] = None
    """
    XML containing the content of the communication.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")
    object_id_prepositional: Optional[str] = None
    """
    Guid of the object this communication is related to.
    """

Python 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
	}
}