Trendsic Platform Service

<back to all web services

AgentEmailCredentialsSendTestRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/AgentEmailCredentialsSendTest
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 AgentEmailCredentials:
    id: int = 0
    agent_id: int = 0
    email_address: Optional[str] = None
    username: Optional[str] = None
    password: Optional[str] = None
    smtp_server: Optional[str] = None
    smtp_port: Optional[int] = None
    smtp_auth_type: Optional[str] = None
    po_p3_server: Optional[str] = None
    po_p3_port: Optional[int] = None
    po_p3_auth_type: Optional[str] = None
    imap_server: Optional[str] = None
    imap_port: Optional[int] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_modified: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentEmailCredentialsResponse:
    response_status: Optional[ResponseStatus] = None
    agent_email_credentials: List[AgentEmailCredentials] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentEmailCredentialsSendTestRequest:
    pass

Python AgentEmailCredentialsSendTestRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/AgentEmailCredentialsSendTest HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	AgentEmailCredentials: 
	[
		{
			Id: 0,
			AgentId: 0,
			EmailAddress: String,
			Username: String,
			Password: String,
			SMTPServer: String,
			SMTPPort: 0,
			SMTPAuthType: String,
			POP3Server: String,
			POP3Port: 0,
			POP3AuthType: String,
			IMAPServer: String,
			IMAPPort: 0,
			DateCreated: 0001-01-01,
			DateModified: 0001-01-01
		}
	]
}