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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class EmailQueue
    {
        public virtual int EmailQueueId { get; set; }
        public virtual string Recipient { get; set; }
        public virtual string Sender { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Body { get; set; }
        public virtual bool IsBodyHTML { get; set; }
        public virtual bool SendThroughAppEmail { get; set; }
        public virtual string SenderUserId { get; set; }
        public virtual string EmailFromName { get; set; }
        public virtual DateTime DateCompleted { get; set; }
        public virtual DateTime DateToSend { get; set; }
        public virtual int FailCount { get; set; }
    }

    public partial class EmailQueueSearchRequest
    {
        public virtual string SearchTerm { get; set; }
    }

    public partial class EmailQueueSearchResponse
    {
        public virtual List<EmailQueue> QueueSearchResults { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# EmailQueueSearchRequest DTOs

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			DateToSend: 0001-01-01,
			FailCount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}