| Required role: | Administrator | Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/EmailQueueSearch/{SearchTerm} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/EmailQueueSearch |
import Foundation
import ServiceStack
public class EmailQueueSearchRequest : Codable
{
public var searchTerm:String
required public init(){}
}
public class EmailQueueSearchResponse : Codable
{
public var queueSearchResults:[EmailQueue] = []
public var responseStatus:ResponseStatus
required public init(){}
}
public class EmailQueue : Codable
{
public var emailQueueId:Int
public var recipient:String
public var sender:String
public var subject:String
public var body:String
public var isBodyHTML:Bool
public var sendThroughAppEmail:Bool
public var senderUserId:String
public var emailFromName:String
public var dateCompleted:Date
public var dateToSend:Date
public var failCount:Int
required public init(){}
}
Swift EmailQueueSearchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}