Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication

/** @description Inserts a communication that is not already saved. */
// @Api(Description="Inserts a communication that is not already saved.")
export class SaveCommunication implements ISubscription
{
    /** @description Guid representing the external systems datasource information. */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    public SuiteDataSourceInstanceId: string;

    /** @description The unique key that represents the communication on the external system. */
    // @ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")
    public AlternateKey: string;

    /** @description Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key. */
    // @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 ObjectId: string;

    public IgnoreValidation: boolean;
    /** @description Communication Status Id. */
    // @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
    public CommunicationStatusId: string;

    /** @description XML containing the content of the communication. */
    // @ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")
    public CommunicationXml: string;

    /** @description Guid of the object this communication is related to. */
    // @ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")
    public ObjectIdPrepositional: string;

    public constructor(init?: Partial<SaveCommunication>) { (Object as any).assign(this, init); }
}

TypeScript SaveCommunication DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/SaveCommunication HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AlternateKey":"String","IgnoreValidation":false,"CommunicationXml":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}