Trendsic Platform Service

<back to all web services

ActivityTrackerReportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ActivityTracker/Report/{StartDate}/{EndDate}
<?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 ActivityTracker_Report implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var int */
        public int $SetAppt=0,
        /** @var int */
        public int $FirstAppt=0,
        /** @var int */
        public int $FollowAppt=0,
        /** @var int */
        public int $FirstContact=0,
        /** @var int */
        public int $Referral=0,
        /** @var int */
        public int $ClientUpdate=0,
        /** @var int */
        public int $SecondAppointment=0,
        /** @var int */
        public int $Appl=0,
        /** @var float */
        public float $LifeAP=0.0,
        /** @var float */
        public float $AnnuityFlow=0.0,
        /** @var float */
        public float $AnnuityTransfer=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
        if (isset($o['SetAppt'])) $this->SetAppt = $o['SetAppt'];
        if (isset($o['FirstAppt'])) $this->FirstAppt = $o['FirstAppt'];
        if (isset($o['FollowAppt'])) $this->FollowAppt = $o['FollowAppt'];
        if (isset($o['FirstContact'])) $this->FirstContact = $o['FirstContact'];
        if (isset($o['Referral'])) $this->Referral = $o['Referral'];
        if (isset($o['ClientUpdate'])) $this->ClientUpdate = $o['ClientUpdate'];
        if (isset($o['SecondAppointment'])) $this->SecondAppointment = $o['SecondAppointment'];
        if (isset($o['Appl'])) $this->Appl = $o['Appl'];
        if (isset($o['LifeAP'])) $this->LifeAP = $o['LifeAP'];
        if (isset($o['AnnuityFlow'])) $this->AnnuityFlow = $o['AnnuityFlow'];
        if (isset($o['AnnuityTransfer'])) $this->AnnuityTransfer = $o['AnnuityTransfer'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
        if (isset($this->SetAppt)) $o['SetAppt'] = $this->SetAppt;
        if (isset($this->FirstAppt)) $o['FirstAppt'] = $this->FirstAppt;
        if (isset($this->FollowAppt)) $o['FollowAppt'] = $this->FollowAppt;
        if (isset($this->FirstContact)) $o['FirstContact'] = $this->FirstContact;
        if (isset($this->Referral)) $o['Referral'] = $this->Referral;
        if (isset($this->ClientUpdate)) $o['ClientUpdate'] = $this->ClientUpdate;
        if (isset($this->SecondAppointment)) $o['SecondAppointment'] = $this->SecondAppointment;
        if (isset($this->Appl)) $o['Appl'] = $this->Appl;
        if (isset($this->LifeAP)) $o['LifeAP'] = $this->LifeAP;
        if (isset($this->AnnuityFlow)) $o['AnnuityFlow'] = $this->AnnuityFlow;
        if (isset($this->AnnuityTransfer)) $o['AnnuityTransfer'] = $this->AnnuityTransfer;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ActivityTrackerReportRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $StartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $EndDate=new DateTime()
    ) {
    }

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

PHP ActivityTrackerReportRequest 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/ActivityTracker/Report/{StartDate}/{EndDate} 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"}},"ReportData":[{"AgentName":"String","SetAppt":0,"FirstAppt":0,"FollowAppt":0,"FirstContact":0,"Referral":0,"ClientUpdate":0,"SecondAppointment":0,"Appl":0,"LifeAP":0,"AnnuityFlow":0,"AnnuityTransfer":0}]}