digitaluapi

<back to all web services

SendCampaignCommunicationsTest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/test/{ScheduleInstancesId}Get Campaign Communications
import 'package:servicestack/servicestack.dart';
import 'dart:collection';

class SendCampaignCommunicationsResponse implements IConvertible
{
    bool? Status;
    ResponseStatus? ResponseStatus;

    SendCampaignCommunicationsResponse({this.Status,this.ResponseStatus});
    SendCampaignCommunicationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Status': Status,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class SendCampaignCommunicationsTest implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? ScheduleInstancesId;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    String? EmailAddress;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    String? MobileNumber;

    // @DataMember(Order=3)
    int? NoOfRecords;

    SendCampaignCommunicationsTest({this.ScheduleInstancesId,this.EmailAddress,this.MobileNumber,this.NoOfRecords});
    SendCampaignCommunicationsTest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ScheduleInstancesId = json['ScheduleInstancesId'];
        EmailAddress = json['EmailAddress'];
        MobileNumber = json['MobileNumber'];
        NoOfRecords = json['NoOfRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ScheduleInstancesId': ScheduleInstancesId,
        'EmailAddress': EmailAddress,
        'MobileNumber': MobileNumber,
        'NoOfRecords': NoOfRecords
    };

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

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'SendCampaignCommunicationsResponse': TypeInfo(TypeOf.Class, create:() => SendCampaignCommunicationsResponse()),
    'SendCampaignCommunicationsTest': TypeInfo(TypeOf.Class, create:() => SendCampaignCommunicationsTest()),
});

Dart SendCampaignCommunicationsTest 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 /campaign/communications/test/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ScheduleInstancesId: 0,
	EmailAddress: String,
	MobileNumber: String,
	NoOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}