Trendsic Platform Service

<back to all web services

EmailQueueSearchRequest

Requires Authentication
Required role:AdministratorRequires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/EmailQueueSearch/{SearchTerm}
GET,OPTIONS/v1/EmailQueueSearch
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class EmailQueue implements IConvertible
{
    int? EmailQueueId;
    String? Recipient;
    String? Sender;
    String? Subject;
    String? Body;
    bool? IsBodyHTML;
    bool? SendThroughAppEmail;
    String? SenderUserId;
    String? EmailFromName;
    DateTime? DateCompleted;
    DateTime? DateToSend;
    int? FailCount;

    EmailQueue({this.EmailQueueId,this.Recipient,this.Sender,this.Subject,this.Body,this.IsBodyHTML,this.SendThroughAppEmail,this.SenderUserId,this.EmailFromName,this.DateCompleted,this.DateToSend,this.FailCount});
    EmailQueue.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EmailQueueId = json['EmailQueueId'];
        Recipient = json['Recipient'];
        Sender = json['Sender'];
        Subject = json['Subject'];
        Body = json['Body'];
        IsBodyHTML = json['IsBodyHTML'];
        SendThroughAppEmail = json['SendThroughAppEmail'];
        SenderUserId = json['SenderUserId'];
        EmailFromName = json['EmailFromName'];
        DateCompleted = JsonConverters.fromJson(json['DateCompleted'],'DateTime',context!);
        DateToSend = JsonConverters.fromJson(json['DateToSend'],'DateTime',context!);
        FailCount = json['FailCount'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EmailQueueId': EmailQueueId,
        'Recipient': Recipient,
        'Sender': Sender,
        'Subject': Subject,
        'Body': Body,
        'IsBodyHTML': IsBodyHTML,
        'SendThroughAppEmail': SendThroughAppEmail,
        'SenderUserId': SenderUserId,
        'EmailFromName': EmailFromName,
        'DateCompleted': JsonConverters.toJson(DateCompleted,'DateTime',context!),
        'DateToSend': JsonConverters.toJson(DateToSend,'DateTime',context!),
        'FailCount': FailCount
    };

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

class EmailQueueSearchResponse implements IConvertible
{
    List<EmailQueue>? QueueSearchResults = [];
    ResponseStatus? ResponseStatus;

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

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

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

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

class EmailQueueSearchRequest implements IConvertible
{
    String? SearchTerm;

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

    fromMap(Map<String, dynamic> json) {
        SearchTerm = json['SearchTerm'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SearchTerm': SearchTerm
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'EmailQueue': TypeInfo(TypeOf.Class, create:() => EmailQueue()),
    'EmailQueueSearchResponse': TypeInfo(TypeOf.Class, create:() => EmailQueueSearchResponse()),
    'List<EmailQueue>': TypeInfo(TypeOf.Class, create:() => <EmailQueue>[]),
    'EmailQueueSearchRequest': TypeInfo(TypeOf.Class, create:() => EmailQueueSearchRequest()),
});

Dart EmailQueueSearchRequest 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/EmailQueueSearch/{SearchTerm} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailQueueSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <QueueSearchResults>
    <EmailQueue>
      <Body>String</Body>
      <DateCompleted>0001-01-01T00:00:00</DateCompleted>
      <DateToSend>0001-01-01T00:00:00</DateToSend>
      <EmailFromName>String</EmailFromName>
      <EmailQueueId>0</EmailQueueId>
      <FailCount>0</FailCount>
      <IsBodyHTML>false</IsBodyHTML>
      <Recipient>String</Recipient>
      <SendThroughAppEmail>false</SendThroughAppEmail>
      <Sender>String</Sender>
      <SenderUserId>String</SenderUserId>
      <Subject>String</Subject>
    </EmailQueue>
  </QueueSearchResults>
  <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>
</EmailQueueSearchResponse>