Trendsic Platform Service

<back to all web services

PeraContactTrackingRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Report/PeraContactTracking/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,OPTIONS/v1/Report/PeraContactTracking/{ParamStartDate}/{ParamEndDate}
import Foundation
import ServiceStack

public class PeraContactTrackingRequest : Codable
{
    public var paramStartDate:Date
    public var paramEndDate:Date
    public var agentID:Int

    required public init(){}
}

public class PeraContactTrackingResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var afPeraContact:[PeraContactTracking] = []

    required public init(){}
}

public class PeraContactTracking : AFPeraContact
{
    public var agent:String
    public var followUpDate:Date
    public var district:String
    public var note:String
    public var eventTypeName:String
    public var avp:String
    public var rvp:String
    public var mvp:String
    public var sale:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case agent
        case followUpDate
        case district
        case note
        case eventTypeName
        case avp
        case rvp
        case mvp
        case sale
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        agent = try container.decodeIfPresent(String.self, forKey: .agent)
        followUpDate = try container.decodeIfPresent(Date.self, forKey: .followUpDate)
        district = try container.decodeIfPresent(String.self, forKey: .district)
        note = try container.decodeIfPresent(String.self, forKey: .note)
        eventTypeName = try container.decodeIfPresent(String.self, forKey: .eventTypeName)
        avp = try container.decodeIfPresent(String.self, forKey: .avp)
        rvp = try container.decodeIfPresent(String.self, forKey: .rvp)
        mvp = try container.decodeIfPresent(String.self, forKey: .mvp)
        sale = try container.decodeIfPresent(String.self, forKey: .sale)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if agent != nil { try container.encode(agent, forKey: .agent) }
        if followUpDate != nil { try container.encode(followUpDate, forKey: .followUpDate) }
        if district != nil { try container.encode(district, forKey: .district) }
        if note != nil { try container.encode(note, forKey: .note) }
        if eventTypeName != nil { try container.encode(eventTypeName, forKey: .eventTypeName) }
        if avp != nil { try container.encode(avp, forKey: .avp) }
        if rvp != nil { try container.encode(rvp, forKey: .rvp) }
        if mvp != nil { try container.encode(mvp, forKey: .mvp) }
        if sale != nil { try container.encode(sale, forKey: .sale) }
    }
}

public class AFPeraContact : Codable
{
    public var peraContactId:Int
    public var firstName:String
    public var lastName:String
    public var appointmentDateTime:Date
    public var dateCreated:Date
    public var agentId:Int

    required public init(){}
}


Swift PeraContactTrackingRequest 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.

GET /v1/Report/PeraContactTracking/{ParamStartDate}/{ParamEndDate}/{AgentID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PeraContactTrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AFPeraContact>
    <PeraContactTracking>
      <AgentId>0</AgentId>
      <AppointmentDateTime>0001-01-01T00:00:00</AppointmentDateTime>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <PeraContactId>0</PeraContactId>
      <AVP>String</AVP>
      <Agent>String</Agent>
      <District>String</District>
      <EventTypeName>String</EventTypeName>
      <FollowUpDate>0001-01-01T00:00:00</FollowUpDate>
      <MVP>String</MVP>
      <Note>String</Note>
      <RVP>String</RVP>
      <Sale>String</Sale>
    </PeraContactTracking>
  </AFPeraContact>
  <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>
</PeraContactTrackingResponse>