| Required role: | Administrator | Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/EmailQueueSearch/{SearchTerm} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/EmailQueueSearch |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailQueue:
email_queue_id: int = 0
recipient: Optional[str] = None
sender: Optional[str] = None
subject: Optional[str] = None
body: Optional[str] = None
is_body_h_t_m_l: bool = False
send_through_app_email: bool = False
sender_user_id: Optional[str] = None
email_from_name: Optional[str] = None
date_completed: datetime.datetime = datetime.datetime(1, 1, 1)
date_to_send: datetime.datetime = datetime.datetime(1, 1, 1)
fail_count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailQueueSearchResponse:
queue_search_results: List[EmailQueue] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailQueueSearchRequest:
search_term: Optional[str] = None
Python 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
}
}
}