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 .xml suffix or ?format=xml

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailQueueSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <QueueSearchResults>
    <EmailQueue>
      <Body>String</Body>
      <DateCompleted>0001-01-01T00:00:00</DateCompleted>
      <DateToSend>0001-01-01T00:00:00</DateToSend>
      <EmailFromName>String</EmailFromName>
      <EmailQueueId>0</EmailQueueId>
      <FailCount>0</FailCount>
      <IsBodyHTML>false</IsBodyHTML>
      <Recipient>String</Recipient>
      <SendThroughAppEmail>false</SendThroughAppEmail>
      <Sender>String</Sender>
      <SenderUserId>String</SenderUserId>
      <Subject>String</Subject>
    </EmailQueue>
  </QueueSearchResults>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</EmailQueueSearchResponse>