Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

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

class RuleValidationResult implements IConvertible
{
    String? RuleCode;
    String? Message;
    String? Key;
    String? Tag;
    String? ErrorCode;

    RuleValidationResult({this.RuleCode,this.Message,this.Key,this.Tag,this.ErrorCode});
    RuleValidationResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RuleCode = json['RuleCode'];
        Message = json['Message'];
        Key = json['Key'];
        Tag = json['Tag'];
        ErrorCode = json['ErrorCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RuleCode': RuleCode,
        'Message': Message,
        'Key': Key,
        'Tag': Tag,
        'ErrorCode': ErrorCode
    };

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

class ValidationErrorList implements IConvertible
{
    List<RuleValidationResult>? ValidationErrors;

    ValidationErrorList({this.ValidationErrors});
    ValidationErrorList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ValidationErrors = JsonConverters.fromJson(json['ValidationErrors'],'List<RuleValidationResult>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ValidationErrors': JsonConverters.toJson(ValidationErrors,'List<RuleValidationResult>',context!)
    };

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

class SubscriptionLinkContact implements IConvertible
{
    /**
    * Guid of the contact object within Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
    String? ContactId;

    /**
    * The unique key that represents the contact on the external system.
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
    String? ContactAlternateKey;

    /**
    * Guid of the Role List Item object within Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
    String? RoleId;

    /**
    * The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
    String? RoleAlternateKey;

    SubscriptionLinkContact({this.ContactId,this.ContactAlternateKey,this.RoleId,this.RoleAlternateKey});
    SubscriptionLinkContact.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        ContactAlternateKey = json['ContactAlternateKey'];
        RoleId = json['RoleId'];
        RoleAlternateKey = json['RoleAlternateKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ContactAlternateKey': ContactAlternateKey,
        'RoleId': RoleId,
        'RoleAlternateKey': RoleAlternateKey
    };

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

class SubscriptionContactGroupConnectionModel extends SubscriptionLinkContact implements IConvertible
{
    /**
    * The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.
    */
    // @ApiMember(DataType="int", Description="The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.", Name="Index", ParameterType="query")
    int? Index;

    /**
    * Set this to be true if the contact connection to the group is to be deleted
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact connection to the group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    bool? MarkAsDeleted;

    SubscriptionContactGroupConnectionModel({this.Index,this.MarkAsDeleted});
    SubscriptionContactGroupConnectionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Index = json['Index'];
        MarkAsDeleted = json['MarkAsDeleted'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Index': Index,
        'MarkAsDeleted': MarkAsDeleted
    });

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

class SubscriptionContactGroupModel implements IConvertible
{
    /**
    * A name for the contact group.
    */
    // @ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
    String? ContactGroupName;

    /**
    * Guid of the Role List Item object within Eros that defines the role of the group.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros that defines the role of the group.", IsRequired=true, Name="GroupRoleId", ParameterType="query")
    String? GroupRoleId;

    /**
    * The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
    String? RoleAlternateKey;

    /**
    * A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
    */
    // @ApiMember(DataType="List<SubscriptionContactGroupConnectionModel>", Description="A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.", Name="ContactConnections", ParameterType="query")
    List<SubscriptionContactGroupConnectionModel>? ContactConnections;

    /**
    * Set this to be true if the contact group is to be deleted
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    bool? MarkAsDeleted;

    /**
    * Set this to be true if the contact group is to be archived
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be archived", Name="MarkAsArchived", ParameterType="query")
    bool? MarkAsArchived;

    /**
    * Set this to be true if the contact group is to be restored
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be restored", Name="MarkAsRestored", ParameterType="query")
    bool? MarkAsRestored;

    SubscriptionContactGroupModel({this.ContactGroupName,this.GroupRoleId,this.RoleAlternateKey,this.ContactConnections,this.MarkAsDeleted,this.MarkAsArchived,this.MarkAsRestored});
    SubscriptionContactGroupModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactGroupName = json['ContactGroupName'];
        GroupRoleId = json['GroupRoleId'];
        RoleAlternateKey = json['RoleAlternateKey'];
        ContactConnections = JsonConverters.fromJson(json['ContactConnections'],'List<SubscriptionContactGroupConnectionModel>',context!);
        MarkAsDeleted = json['MarkAsDeleted'];
        MarkAsArchived = json['MarkAsArchived'];
        MarkAsRestored = json['MarkAsRestored'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactGroupName': ContactGroupName,
        'GroupRoleId': GroupRoleId,
        'RoleAlternateKey': RoleAlternateKey,
        'ContactConnections': JsonConverters.toJson(ContactConnections,'List<SubscriptionContactGroupConnectionModel>',context!),
        'MarkAsDeleted': MarkAsDeleted,
        'MarkAsArchived': MarkAsArchived,
        'MarkAsRestored': MarkAsRestored
    };

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

/**
* Inserts or Updates a contact group and its contact connections.
*/
// @Api(Description="Inserts or Updates a contact group and its contact connections.")
class SaveContactGroup extends ValidationErrorList 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 contact group on the external system.
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    String? AlternateKey;

    /**
    * Guid of the contact group 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 contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.", Name="ObjectId", ParameterType="query")
    String? ObjectId;

    /**
    * If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.
    */
    // @ApiMember(DataType="bool", Description="If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.", Name="IgnoreHash")
    bool? IgnoreHash;

    /**
    * Object containing all details of the contact group to be inserted or updated.
    */
    // @ApiMember(DataType="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")
    SubscriptionContactGroupModel? ContactGroup;

    bool? IgnoreValidation;
    String? LicenseeId;
    String? SessionId;

    SaveContactGroup({this.SuiteDataSourceInstanceId,this.AlternateKey,this.ObjectId,this.IgnoreHash,this.ContactGroup,this.IgnoreValidation,this.LicenseeId,this.SessionId});
    SaveContactGroup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        AlternateKey = json['AlternateKey'];
        ObjectId = json['ObjectId'];
        IgnoreHash = json['IgnoreHash'];
        ContactGroup = JsonConverters.fromJson(json['ContactGroup'],'SubscriptionContactGroupModel',context!);
        IgnoreValidation = json['IgnoreValidation'];
        LicenseeId = json['LicenseeId'];
        SessionId = json['SessionId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'AlternateKey': AlternateKey,
        'ObjectId': ObjectId,
        'IgnoreHash': IgnoreHash,
        'ContactGroup': JsonConverters.toJson(ContactGroup,'SubscriptionContactGroupModel',context!),
        'IgnoreValidation': IgnoreValidation,
        'LicenseeId': LicenseeId,
        'SessionId': SessionId
    });

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

TypeContext _ctx = TypeContext(library: 'production_eros_platform_apisubscription.azurewebsites.net', types: <String, TypeInfo> {
    'RuleValidationResult': TypeInfo(TypeOf.Class, create:() => RuleValidationResult()),
    'ValidationErrorList': TypeInfo(TypeOf.Class, create:() => ValidationErrorList()),
    'List<RuleValidationResult>': TypeInfo(TypeOf.Class, create:() => <RuleValidationResult>[]),
    'SubscriptionLinkContact': TypeInfo(TypeOf.Class, create:() => SubscriptionLinkContact()),
    'SubscriptionContactGroupConnectionModel': TypeInfo(TypeOf.Class, create:() => SubscriptionContactGroupConnectionModel()),
    'SubscriptionContactGroupModel': TypeInfo(TypeOf.Class, create:() => SubscriptionContactGroupModel()),
    'List<SubscriptionContactGroupConnectionModel>': TypeInfo(TypeOf.Class, create:() => <SubscriptionContactGroupConnectionModel>[]),
    'SaveContactGroup': TypeInfo(TypeOf.Class, create:() => SaveContactGroup()),
});

Dart SaveContactGroup DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/SaveContactGroup HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AlternateKey":"String","IgnoreHash":false,"ContactGroup":{"ContactGroupName":"String","RoleAlternateKey":"String","ContactConnections":[{"Index":0,"MarkAsDeleted":false,"ContactAlternateKey":"String","RoleAlternateKey":"String"}],"MarkAsDeleted":false,"MarkAsArchived":false,"MarkAsRestored":false},"IgnoreValidation":false,"ValidationErrors":[{"RuleCode":"String","Message":"String","Key":"String","Tag":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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