Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication
"use strict";
export class SaveCommunication {
    /** @param {{SuiteDataSourceInstanceId?:string,AlternateKey?:string,ObjectId?:string,IgnoreValidation?:boolean,CommunicationStatusId?:string,CommunicationXml?:string,ObjectIdPrepositional?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid representing the external systems datasource information. */
    SuiteDataSourceInstanceId;
    /**
     * @type {string}
     * @description The unique key that represents the communication on the external system. */
    AlternateKey;
    /**
     * @type {string}
     * @description Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key. */
    ObjectId;
    /** @type {boolean} */
    IgnoreValidation;
    /**
     * @type {string}
     * @description Communication Status Id. */
    CommunicationStatusId;
    /**
     * @type {string}
     * @description XML containing the content of the communication. */
    CommunicationXml;
    /**
     * @type {string}
     * @description Guid of the object this communication is related to. */
    ObjectIdPrepositional;
}

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