Trendsic Platform Service

AgentPromotionRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/AgentPromotion/{StartDate}
GET,OPTIONS	/v1/AgentPromotion/{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 AgentPromotion implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentPromotionId=0,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $FullName=null,
        /** @var float */
        public float $PreviousLevel=0.0,
        /** @var string|null */
        public ?string $PreviousRank=null,
        /** @var float */
        public float $NewLevel=0.0,
        /** @var string|null */
        public ?string $NewRank=null,
        /** @var float */
        public float $CashFlow=0.0,
        /** @var int */
        public int $AppCount=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime()
    ) {
    }

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

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

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

class AgentPromotionRequest 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 AgentPromotionRequest 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/AgentPromotion/{StartDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentPromotionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentPromotion>
    <AgentPromotion>
      <AgentId>0</AgentId>
      <AgentPromotionId>0</AgentPromotionId>
      <AppCount>0</AppCount>
      <CashFlow>0</CashFlow>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <NewLevel>0</NewLevel>
      <NewRank>String</NewRank>
      <PreviousLevel>0</PreviousLevel>
      <PreviousRank>String</PreviousRank>
    </AgentPromotion>
  </AgentPromotion>
  <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>
</AgentPromotionResponse>