Trendsic Platform Service

<back to all web services

MassCommunicationContactRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/MassCommunicationContact
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class MassCommunicationResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    bool? Success;
    int? Recipients;

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

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

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

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

class MassCommunicationContactRequest implements IConvertible
{
    String? Subject;
    String? Message;
    List<String>? Recipients = [];
    List<String>? Locations = [];
    bool? EmailMissingNumbers;
    bool? EmailAll;
    bool? SMSAll;
    String? ContactCategories;

    MassCommunicationContactRequest({this.Subject,this.Message,this.Recipients,this.Locations,this.EmailMissingNumbers,this.EmailAll,this.SMSAll,this.ContactCategories});
    MassCommunicationContactRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Subject = json['Subject'];
        Message = json['Message'];
        Recipients = JsonConverters.fromJson(json['Recipients'],'List<String>',context!);
        Locations = JsonConverters.fromJson(json['Locations'],'List<String>',context!);
        EmailMissingNumbers = json['EmailMissingNumbers'];
        EmailAll = json['EmailAll'];
        SMSAll = json['SMSAll'];
        ContactCategories = json['ContactCategories'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Subject': Subject,
        'Message': Message,
        'Recipients': JsonConverters.toJson(Recipients,'List<String>',context!),
        'Locations': JsonConverters.toJson(Locations,'List<String>',context!),
        'EmailMissingNumbers': EmailMissingNumbers,
        'EmailAll': EmailAll,
        'SMSAll': SMSAll,
        'ContactCategories': ContactCategories
    };

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

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

Dart MassCommunicationContactRequest 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 /v1/MassCommunicationContact HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MassCommunicationContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactCategories>String</ContactCategories>
  <EmailAll>false</EmailAll>
  <EmailMissingNumbers>false</EmailMissingNumbers>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Locations>
  <Message>String</Message>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Recipients>
  <SMSAll>false</SMSAll>
  <Subject>String</Subject>
</MassCommunicationContactRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MassCommunicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Recipients>0</Recipients>
  <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>
  <Success>false</Success>
</MassCommunicationResponse>