Platform Subscription API

<back to all web services

SaveContactRole

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 SubscriptionContactRoleModel implements IConvertible
{
    /**
    * Name of the role.
    */
    // @ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")
    String? RoleName;

    /**
    * Short version of the role name.
    */
    // @ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")
    String? RoleShortName;

    /**
    * Description of the role purpose.
    */
    // @ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")
    String? RoleDescription;

    /**
    * If true, the role will be pending for a contact until they accept it.
    */
    // @ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")
    bool? RequireContactsToAccept;

    /**
    * Contact Types that may have this role.
    */
    // @ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")
    List<String>? ContactTypes;

    /**
    * Role Filters this role should be added to.
    */
    // @ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")
    List<String>? ListItemFilters;

    SubscriptionContactRoleModel({this.RoleName,this.RoleShortName,this.RoleDescription,this.RequireContactsToAccept,this.ContactTypes,this.ListItemFilters});
    SubscriptionContactRoleModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RoleName = json['RoleName'];
        RoleShortName = json['RoleShortName'];
        RoleDescription = json['RoleDescription'];
        RequireContactsToAccept = json['RequireContactsToAccept'];
        ContactTypes = JsonConverters.fromJson(json['ContactTypes'],'List<String>',context!);
        ListItemFilters = JsonConverters.fromJson(json['ListItemFilters'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RoleName': RoleName,
        'RoleShortName': RoleShortName,
        'RoleDescription': RoleDescription,
        'RequireContactsToAccept': RequireContactsToAccept,
        'ContactTypes': JsonConverters.toJson(ContactTypes,'List<String>',context!),
        'ListItemFilters': JsonConverters.toJson(ListItemFilters,'List<String>',context!)
    };

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

class SaveContactRole extends ValidationErrorList implements ISubscription, IConvertible
{
    /**
    * Guid representing the external systems data source information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    String? SuiteDataSourceInstanceId;

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

    /**
    * Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
    String? ObjectId;

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

    bool? IgnoreValidation;

    SaveContactRole({this.SuiteDataSourceInstanceId,this.AlternateKey,this.ObjectId,this.ContactRole,this.IgnoreValidation});
    SaveContactRole.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'AlternateKey': AlternateKey,
        'ObjectId': ObjectId,
        'ContactRole': JsonConverters.toJson(ContactRole,'SubscriptionContactRoleModel',context!),
        'IgnoreValidation': IgnoreValidation
    });

    getTypeName() => "SaveContactRole";
    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>[]),
    'SubscriptionContactRoleModel': TypeInfo(TypeOf.Class, create:() => SubscriptionContactRoleModel()),
    'SaveContactRole': TypeInfo(TypeOf.Class, create:() => SaveContactRole()),
});

Dart SaveContactRole DTOs

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

HTTP + CSV

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

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

{"AlternateKey":"String","ContactRole":{"RoleName":"String","RoleShortName":"String","RoleDescription":"String","RequireContactsToAccept":false,"ContactTypes":["00000000-0000-0000-0000-000000000000"],"ListItemFilters":["00000000-0000-0000-0000-000000000000"]},"IgnoreValidation":false,"ValidationErrors":[{"RuleCode":"String","Message":"String","Key":"String","Tag":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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