| Required role: | Administrator | Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/EmailQueueSearch/{SearchTerm} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/EmailQueueSearch |
export class EmailQueue
{
public EmailQueueId: number;
public Recipient: string;
public Sender: string;
public Subject: string;
public Body: string;
public IsBodyHTML: boolean;
public SendThroughAppEmail: boolean;
public SenderUserId: string;
public EmailFromName: string;
public DateCompleted: string;
public DateToSend: string;
public FailCount: number;
public constructor(init?: Partial<EmailQueue>) { (Object as any).assign(this, init); }
}
export class EmailQueueSearchResponse
{
public QueueSearchResults: EmailQueue[] = [];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<EmailQueueSearchResponse>) { (Object as any).assign(this, init); }
}
export class EmailQueueSearchRequest
{
public SearchTerm: string;
public constructor(init?: Partial<EmailQueueSearchRequest>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
}
}