digitaluapi

<back to all web services

StartCampaignCommunications

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

class StartCampaignCommunications implements IConvertible
{
    // @DataMember(Order=1)
    int? ScheduleInstancesId;

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

    // @DataMember(Order=3)
    List<int>? Channels;

    StartCampaignCommunications({this.ScheduleInstancesId,this.NoOfRecords,this.Channels});
    StartCampaignCommunications.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ScheduleInstancesId': ScheduleInstancesId,
        'NoOfRecords': NoOfRecords,
        'Channels': JsonConverters.toJson(Channels,'List<int>',context!)
    };

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

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

Dart StartCampaignCommunications DTOs

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

HTTP + XML

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

POST /campaign/communications/start/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartCampaignCommunications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Channels>
  <NoOfRecords>0</NoOfRecords>
  <ScheduleInstancesId>0</ScheduleInstancesId>
</StartCampaignCommunications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>