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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EmailQueue() = 
        member val EmailQueueId:Int32 = new Int32() with get,set
        member val Recipient:String = null with get,set
        member val Sender:String = null with get,set
        member val Subject:String = null with get,set
        member val Body:String = null with get,set
        member val IsBodyHTML:Boolean = new Boolean() with get,set
        member val SendThroughAppEmail:Boolean = new Boolean() with get,set
        member val SenderUserId:String = null with get,set
        member val EmailFromName:String = null with get,set
        member val DateCompleted:DateTime = new DateTime() with get,set
        member val DateToSend:DateTime = new DateTime() with get,set
        member val FailCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type EmailQueueSearchResponse() = 
        member val QueueSearchResults:ResizeArray<EmailQueue> = new ResizeArray<EmailQueue>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EmailQueueSearchRequest() = 
        member val SearchTerm:String = null with get,set

F# 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
		}
	}
}