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

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class EmailQueue
            Public Overridable Property EmailQueueId As Integer
            Public Overridable Property Recipient As String
            Public Overridable Property Sender As String
            Public Overridable Property Subject As String
            Public Overridable Property Body As String
            Public Overridable Property IsBodyHTML As Boolean
            Public Overridable Property SendThroughAppEmail As Boolean
            Public Overridable Property SenderUserId As String
            Public Overridable Property EmailFromName As String
            Public Overridable Property DateCompleted As Date
            Public Overridable Property DateToSend As Date
            Public Overridable Property FailCount As Integer
        End Class

        Public Partial Class EmailQueueSearchRequest
            Public Overridable Property SearchTerm As String
        End Class

        Public Partial Class EmailQueueSearchResponse
            Public Overridable Property QueueSearchResults As List(Of EmailQueue) = New List(Of EmailQueue)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET EmailQueueSearchRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}