Platform Subscription API

SaveCommunication

Inserts a communication that is not already saved.

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

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

    /**
    * 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")
    String? AlternateKey;

    /**
    * 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")
    String? ObjectId;

    bool? IgnoreValidation;
    /**
    * Communication Status Id.
    */
    // @ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")
    String? CommunicationStatusId;

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

    /**
    * 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")
    String? ObjectIdPrepositional;

    SaveCommunication({this.SuiteDataSourceInstanceId,this.AlternateKey,this.ObjectId,this.IgnoreValidation,this.CommunicationStatusId,this.CommunicationXml,this.ObjectIdPrepositional});
    SaveCommunication.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        AlternateKey = json['AlternateKey'];
        ObjectId = json['ObjectId'];
        IgnoreValidation = json['IgnoreValidation'];
        CommunicationStatusId = json['CommunicationStatusId'];
        CommunicationXml = json['CommunicationXml'];
        ObjectIdPrepositional = json['ObjectIdPrepositional'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'AlternateKey': AlternateKey,
        'ObjectId': ObjectId,
        'IgnoreValidation': IgnoreValidation,
        'CommunicationStatusId': CommunicationStatusId,
        'CommunicationXml': CommunicationXml,
        'ObjectIdPrepositional': ObjectIdPrepositional
    };

    getTypeName() => "SaveCommunication";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'production_eros_platform_apisubscription.azurewebsites.net', types: <String, TypeInfo> {
    'SaveCommunication': TypeInfo(TypeOf.Class, create:() => SaveCommunication()),
});

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