Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
SaveCommunication Parameters:
NameParameterData TypeRequiredDescription
SuiteDataSourceInstanceIdqueryGuidYesGuid representing the external systems datasource information.
AlternateKeyquerystringNoThe unique key that represents the communication on the external system.
ObjectIdqueryGuidYesGuid of the communication object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key.
IgnoreValidationqueryboolNo
CommunicationStatusIdqueryGuidYesCommunication Status Id.
CommunicationXmlquerystringYesXML containing the content of the communication.
ObjectIdPrepositionalqueryGuidYesGuid of the object this communication is related to.

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