Trendsic Platform Service

<back to all web services

AgentPromotionsHistoryRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentPromotionsHistory/{AgentId}
<?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 AgentPromotionsHistory implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentLevel=0,
        /** @var DateTime */
        public DateTime $PromotionDate=new DateTime(),
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $NextPromotionDescription=null,
        /** @var string|null */
        public ?string $NextPromotionGuideline=null
    ) {
    }

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

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

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

class AgentPromotionsHistoryRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0
    ) {
    }

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

PHP AgentPromotionsHistoryRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/AgentPromotionsHistory/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"result":[{"AgentLevel":0,"PromotionDate":"0001-01-01T00:00:00.0000000","Description":"String","NextPromotionDescription":"String","NextPromotionGuideline":"String"}]}