Trendsic Platform Service

CampaignRecipientsRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/campaigns/{Id}/runs/{RunId}/recipients

import 'package:servicestack/servicestack.dart';

class CampaignJsonResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

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

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

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

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

class CampaignRecipientsRequest implements IConvertible
{
    int? Id;
    int? RunId;
    String? Status;
    String? Channel;
    String? Q;
    int? Page;
    int? Size;
    String? Sort;
    String? Dir;

    CampaignRecipientsRequest({this.Id,this.RunId,this.Status,this.Channel,this.Q,this.Page,this.Size,this.Sort,this.Dir});
    CampaignRecipientsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        RunId = json['RunId'];
        Status = json['Status'];
        Channel = json['Channel'];
        Q = json['Q'];
        Page = json['Page'];
        Size = json['Size'];
        Sort = json['Sort'];
        Dir = json['Dir'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'RunId': RunId,
        'Status': Status,
        'Channel': Channel,
        'Q': Q,
        'Page': Page,
        'Size': Size,
        'Sort': Sort,
        'Dir': Dir
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'CampaignJsonResponse': TypeInfo(TypeOf.Class, create:() => CampaignJsonResponse()),
    'CampaignRecipientsRequest': TypeInfo(TypeOf.Class, create:() => CampaignRecipientsRequest()),
});

Dart CampaignRecipientsRequest 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.

GET /v1/campaigns/{Id}/runs/{RunId}/recipients HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignJsonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CampaignJsonResponse>