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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class EmailQueueSearchRequest
{
    open var SearchTerm:String? = null
}

open class EmailQueueSearchResponse
{
    open var QueueSearchResults:ArrayList<EmailQueue> = ArrayList<EmailQueue>()
    open var ResponseStatus:ResponseStatus? = null
}

open class EmailQueue
{
    open var EmailQueueId:Int? = null
    open var Recipient:String? = null
    open var Sender:String? = null
    open var Subject:String? = null
    open var Body:String? = null
    open var IsBodyHTML:Boolean? = null
    open var SendThroughAppEmail:Boolean? = null
    open var SenderUserId:String? = null
    open var EmailFromName:String? = null
    open var DateCompleted:Date? = null
    open var DateToSend:Date? = null
    open var FailCount:Int? = null
}

Kotlin 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
		}
	}
}