Trendsic Platform Service

<back to all web services

AgentEmailCredentialsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/AgentEmailCredentials
"use strict";
export class AgentEmailCredentials {
    /** @param {{Id?:number,AgentId?:number,EmailAddress?:string,Username?:string,Password?:string,SMTPServer?:string,SMTPPort?:number,SMTPAuthType?:string,POP3Server?:string,POP3Port?:number,POP3AuthType?:string,IMAPServer?:string,IMAPPort?:number,DateCreated?:string,DateModified?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    Username;
    /** @type {string} */
    Password;
    /** @type {string} */
    SMTPServer;
    /** @type {?number} */
    SMTPPort;
    /** @type {string} */
    SMTPAuthType;
    /** @type {string} */
    POP3Server;
    /** @type {?number} */
    POP3Port;
    /** @type {string} */
    POP3AuthType;
    /** @type {string} */
    IMAPServer;
    /** @type {?number} */
    IMAPPort;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
}
export class AgentEmailCredentialsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentEmailCredentials?:AgentEmailCredentials[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentEmailCredentials[]} */
    AgentEmailCredentials = [];
}
export class AgentEmailCredentialsRequest {
    /** @param {{AgentEmailCredentials?:AgentEmailCredentials[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgentEmailCredentials[]} */
    AgentEmailCredentials = [];
}

JavaScript AgentEmailCredentialsRequest 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/AgentEmailCredentials HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	]
}
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
		}
	]
}