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}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class AFPeraContact implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PeraContactId=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var DateTime */
        public DateTime $AppointmentDateTime=new DateTime(),
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var int */
        public int $AgentId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PeraContactId'])) $this->PeraContactId = $o['PeraContactId'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['AppointmentDateTime'])) $this->AppointmentDateTime = JsonConverters::from('DateTime', $o['AppointmentDateTime']);
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PeraContactId)) $o['PeraContactId'] = $this->PeraContactId;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->AppointmentDateTime)) $o['AppointmentDateTime'] = JsonConverters::to('DateTime', $this->AppointmentDateTime);
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        return empty($o) ? new class(){} : $o;
    }
}

class PeraContactTracking extends AFPeraContact implements JsonSerializable
{
    /**
     * @param int $PeraContactId
     * @param string|null $FirstName
     * @param string|null $LastName
     * @param DateTime $AppointmentDateTime
     * @param DateTime $DateCreated
     * @param int $AgentId
     */
    public function __construct(
        int $PeraContactId=0,
        ?string $FirstName=null,
        ?string $LastName=null,
        DateTime $AppointmentDateTime=new DateTime(),
        DateTime $DateCreated=new DateTime(),
        int $AgentId=0,
        /** @var string|null */
        public ?string $Agent=null,
        /** @var DateTime */
        public DateTime $FollowUpDate=new DateTime(),
        /** @var string|null */
        public ?string $District=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var string|null */
        public ?string $EventTypeName=null,
        /** @var string|null */
        public ?string $AVP=null,
        /** @var string|null */
        public ?string $RVP=null,
        /** @var string|null */
        public ?string $MVP=null,
        /** @var string|null */
        public ?string $Sale=null
    ) {
        parent::__construct($PeraContactId,$FirstName,$LastName,$AppointmentDateTime,$DateCreated,$AgentId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Agent'])) $this->Agent = $o['Agent'];
        if (isset($o['FollowUpDate'])) $this->FollowUpDate = JsonConverters::from('DateTime', $o['FollowUpDate']);
        if (isset($o['District'])) $this->District = $o['District'];
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['EventTypeName'])) $this->EventTypeName = $o['EventTypeName'];
        if (isset($o['AVP'])) $this->AVP = $o['AVP'];
        if (isset($o['RVP'])) $this->RVP = $o['RVP'];
        if (isset($o['MVP'])) $this->MVP = $o['MVP'];
        if (isset($o['Sale'])) $this->Sale = $o['Sale'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Agent)) $o['Agent'] = $this->Agent;
        if (isset($this->FollowUpDate)) $o['FollowUpDate'] = JsonConverters::to('DateTime', $this->FollowUpDate);
        if (isset($this->District)) $o['District'] = $this->District;
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->EventTypeName)) $o['EventTypeName'] = $this->EventTypeName;
        if (isset($this->AVP)) $o['AVP'] = $this->AVP;
        if (isset($this->RVP)) $o['RVP'] = $this->RVP;
        if (isset($this->MVP)) $o['MVP'] = $this->MVP;
        if (isset($this->Sale)) $o['Sale'] = $this->Sale;
        return empty($o) ? new class(){} : $o;
    }
}

class PeraContactTrackingResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<PeraContactTracking>|null */
        public ?array $AFPeraContact=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['AFPeraContact'])) $this->AFPeraContact = JsonConverters::fromArray('PeraContactTracking', $o['AFPeraContact']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->AFPeraContact)) $o['AFPeraContact'] = JsonConverters::toArray('PeraContactTracking', $this->AFPeraContact);
        return empty($o) ? new class(){} : $o;
    }
}

class PeraContactTrackingRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $ParamStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ParamEndDate=new DateTime(),
        /** @var int */
        public int $AgentID=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ParamStartDate'])) $this->ParamStartDate = JsonConverters::from('DateTime', $o['ParamStartDate']);
        if (isset($o['ParamEndDate'])) $this->ParamEndDate = JsonConverters::from('DateTime', $o['ParamEndDate']);
        if (isset($o['AgentID'])) $this->AgentID = $o['AgentID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ParamStartDate)) $o['ParamStartDate'] = JsonConverters::to('DateTime', $this->ParamStartDate);
        if (isset($this->ParamEndDate)) $o['ParamEndDate'] = JsonConverters::to('DateTime', $this->ParamEndDate);
        if (isset($this->AgentID)) $o['AgentID'] = $this->AgentID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PeraContactTrackingRequest DTOs

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

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AFPeraContact":[{"Agent":"String","FollowUpDate":"0001-01-01T00:00:00.0000000","District":"String","Note":"String","EventTypeName":"String","AVP":"String","RVP":"String","MVP":"String","Sale":"String","PeraContactId":0,"FirstName":"String","LastName":"String","AppointmentDateTime":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","AgentId":0}]}