| Required role: | Administrator | Requires any of the roles: | Agent, Administrator |
| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"QueueSearchResults":[{"EmailQueueId":0,"Recipient":"String","Sender":"String","Subject":"String","Body":"String","IsBodyHTML":false,"SendThroughAppEmail":false,"SenderUserId":"String","EmailFromName":"String","DateCompleted":"0001-01-01T00:00:00.0000000","DateToSend":"0001-01-01T00:00:00.0000000","FailCount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}