Trendsic Platform Service

<back to all web services

AgentHierarchyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentHierarchyById/{AgentNumber}
GET,OPTIONS/v1/AgentHierarchy
<?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 AgentHierarchy implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PackageCost=null,
        /** @var string|null */
        public ?string $Package=null,
        /** @var string|null */
        public ?string $AgentNumber=null,
        /** @var string|null */
        public ?string $PlacementAgent=null,
        /** @var string|null */
        public ?string $Company=null,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $MiddleInitial=null,
        /** @var string|null */
        public ?string $Email=null,
        /** @var string|null */
        public ?string $HomePhone=null,
        /** @var string|null */
        public ?string $CellPhone=null,
        /** @var string|null */
        public ?string $WorkPhone=null,
        /** @var string|null */
        public ?string $Level=null,
        /** @var string|null */
        public ?string $label=null,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $AgentStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PackageCost'])) $this->PackageCost = $o['PackageCost'];
        if (isset($o['Package'])) $this->Package = $o['Package'];
        if (isset($o['AgentNumber'])) $this->AgentNumber = $o['AgentNumber'];
        if (isset($o['PlacementAgent'])) $this->PlacementAgent = $o['PlacementAgent'];
        if (isset($o['Company'])) $this->Company = $o['Company'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['MiddleInitial'])) $this->MiddleInitial = $o['MiddleInitial'];
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['HomePhone'])) $this->HomePhone = $o['HomePhone'];
        if (isset($o['CellPhone'])) $this->CellPhone = $o['CellPhone'];
        if (isset($o['WorkPhone'])) $this->WorkPhone = $o['WorkPhone'];
        if (isset($o['Level'])) $this->Level = $o['Level'];
        if (isset($o['label'])) $this->label = $o['label'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['AgentStatus'])) $this->AgentStatus = $o['AgentStatus'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PackageCost)) $o['PackageCost'] = $this->PackageCost;
        if (isset($this->Package)) $o['Package'] = $this->Package;
        if (isset($this->AgentNumber)) $o['AgentNumber'] = $this->AgentNumber;
        if (isset($this->PlacementAgent)) $o['PlacementAgent'] = $this->PlacementAgent;
        if (isset($this->Company)) $o['Company'] = $this->Company;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->MiddleInitial)) $o['MiddleInitial'] = $this->MiddleInitial;
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->HomePhone)) $o['HomePhone'] = $this->HomePhone;
        if (isset($this->CellPhone)) $o['CellPhone'] = $this->CellPhone;
        if (isset($this->WorkPhone)) $o['WorkPhone'] = $this->WorkPhone;
        if (isset($this->Level)) $o['Level'] = $this->Level;
        if (isset($this->label)) $o['label'] = $this->label;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->AgentStatus)) $o['AgentStatus'] = $this->AgentStatus;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AgentHierarchyRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $AgentNumber=null,
        /** @var bool|null */
        public ?bool $IncludeInactive=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentNumber'])) $this->AgentNumber = $o['AgentNumber'];
        if (isset($o['IncludeInactive'])) $this->IncludeInactive = $o['IncludeInactive'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentNumber)) $o['AgentNumber'] = $this->AgentNumber;
        if (isset($this->IncludeInactive)) $o['IncludeInactive'] = $this->IncludeInactive;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AgentHierarchyRequest 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/AgentHierarchyById/{AgentNumber} 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"}},"AgentHierarchy":[{"PackageCost":"String","Package":"String","AgentNumber":"String","PlacementAgent":"String","Company":"String","FirstName":"String","LastName":"String","MiddleInitial":"String","Email":"String","HomePhone":"String","CellPhone":"String","WorkPhone":"String","Level":"String","label":"String","AgentId":0,"AgentStatus":"String"}]}