Trendsic Platform Service

EmailQueueSearchRequest

**Requires Authentication**
Required role:	Administrator	Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/EmailQueueSearch/{SearchTerm}
GET,OPTIONS	/v1/EmailQueueSearch

"use strict";
export class EmailQueue {
    /** @param {{EmailQueueId?:number,Recipient?:string,Sender?:string,Subject?:string,Body?:string,IsBodyHTML?:boolean,SendThroughAppEmail?:boolean,SenderUserId?:string,EmailFromName?:string,DateCompleted?:string,DateToSend?:string,FailCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EmailQueueId;
    /** @type {string} */
    Recipient;
    /** @type {string} */
    Sender;
    /** @type {string} */
    Subject;
    /** @type {string} */
    Body;
    /** @type {boolean} */
    IsBodyHTML;
    /** @type {boolean} */
    SendThroughAppEmail;
    /** @type {string} */
    SenderUserId;
    /** @type {string} */
    EmailFromName;
    /** @type {string} */
    DateCompleted;
    /** @type {string} */
    DateToSend;
    /** @type {number} */
    FailCount;
}
export class EmailQueueSearchResponse {
    /** @param {{QueueSearchResults?:EmailQueue[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {EmailQueue[]} */
    QueueSearchResults = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EmailQueueSearchRequest {
    /** @param {{SearchTerm?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SearchTerm;
}

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