Trendsic Platform Service

<back to all web services

ContactHistoryRequest

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/ContactHistory/{ContactHistoryId}
GET,POST,PUT,DELETE,OPTIONS/v1/ContactHistory
"use strict";
export class ContactHistory {
    /** @param {{ContactHistoryId?:number,ContactId?:number,EventId?:number,AgentId?:number,EventDate?:string,DateCreated?:string,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactHistoryId;
    /** @type {number} */
    ContactId;
    /** @type {number} */
    EventId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    EventDate;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    Note;
}
export class ActivityTracker_Application {
    /** @param {{ContactName?:string,Carriers?:string,ApplicationId?:number,ContactId?:number,LifeAP?:number,AnnuityFlow?:number,AnnuityTransfer?:number,DateCreated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ContactName;
    /** @type {string} */
    Carriers;
    /** @type {number} */
    ApplicationId;
    /** @type {number} */
    ContactId;
    /** @type {number} */
    LifeAP;
    /** @type {number} */
    AnnuityFlow;
    /** @type {number} */
    AnnuityTransfer;
    /** @type {string} */
    DateCreated;
}
export class ContactHistoryExtended extends ContactHistory {
    /** @param {{EventTypeName?:string,Application?:ActivityTracker_Application[],ContactHistoryId?:number,ContactId?:number,EventId?:number,AgentId?:number,EventDate?:string,DateCreated?:string,Note?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    EventTypeName;
    /** @type {ActivityTracker_Application[]} */
    Application = [];
}
export class ContactHistoryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ContactHistory?:ContactHistoryExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ContactHistoryExtended[]} */
    ContactHistory = [];
}
export class ContactHistoryRequest {
    /** @param {{ContactHistory?:ContactHistory[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ContactHistory[]} */
    ContactHistory = [];
}

JavaScript ContactHistoryRequest 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/ContactHistory/{ContactHistoryId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactHistory>
    <ContactHistory>
      <AgentId>0</AgentId>
      <ContactHistoryId>0</ContactHistoryId>
      <ContactId>0</ContactId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <Note>String</Note>
    </ContactHistory>
  </ContactHistory>
</ContactHistoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactHistory>
    <ContactHistoryExtended>
      <AgentId>0</AgentId>
      <ContactHistoryId>0</ContactHistoryId>
      <ContactId>0</ContactId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <Note>String</Note>
      <Application>
        <ActivityTracker_Application>
          <AnnuityFlow>0</AnnuityFlow>
          <AnnuityTransfer>0</AnnuityTransfer>
          <ApplicationId>0</ApplicationId>
          <Carriers>String</Carriers>
          <ContactId>0</ContactId>
          <ContactName>String</ContactName>
          <DateCreated>0001-01-01T00:00:00</DateCreated>
          <LifeAP>0</LifeAP>
        </ActivityTracker_Application>
      </Application>
      <EventTypeName>String</EventTypeName>
    </ContactHistoryExtended>
  </ContactHistory>
  <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>
</ContactHistoryResponse>