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
"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 AgentEmailCredentialsSendTestRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript AgentEmailCredentialsSendTestRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AgentEmailCredentialsSendTestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentEmailCredentialsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentEmailCredentials>
    <AgentEmailCredentials>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <EmailAddress>String</EmailAddress>
      <IMAPPort>0</IMAPPort>
      <IMAPServer>String</IMAPServer>
      <Id>0</Id>
      <POP3AuthType>String</POP3AuthType>
      <POP3Port>0</POP3Port>
      <POP3Server>String</POP3Server>
      <Password>String</Password>
      <SMTPAuthType>String</SMTPAuthType>
      <SMTPPort>0</SMTPPort>
      <SMTPServer>String</SMTPServer>
      <Username>String</Username>
    </AgentEmailCredentials>
  </AgentEmailCredentials>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AgentEmailCredentialsResponse>