Trendsic Platform Service

<back to all web services

ProductionRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Production
GET/v1/Production/DateRange/{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 Production implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var int */
        public int $MVPID=0,
        /** @var int */
        public int $AVPID=0,
        /** @var int */
        public int $RVPID=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $MiddleInitial=null,
        /** @var float */
        public float $AgentLevel=0.0,
        /** @var string|null */
        public ?string $Rank=null,
        /** @var string|null */
        public ?string $FullName=null,
        /** @var bool|null */
        public ?bool $IsMVP=null,
        /** @var bool|null */
        public ?bool $IsRVP=null,
        /** @var bool|null */
        public ?bool $IsAVP=null,
        /** @var int */
        public int $PolicyCount=0,
        /** @var float */
        public float $AppCount=0.0,
        /** @var float */
        public float $Points=0.0,
        /** @var float */
        public float $Cashflow=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['MVPID'])) $this->MVPID = $o['MVPID'];
        if (isset($o['AVPID'])) $this->AVPID = $o['AVPID'];
        if (isset($o['RVPID'])) $this->RVPID = $o['RVPID'];
        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['AgentLevel'])) $this->AgentLevel = $o['AgentLevel'];
        if (isset($o['Rank'])) $this->Rank = $o['Rank'];
        if (isset($o['FullName'])) $this->FullName = $o['FullName'];
        if (isset($o['IsMVP'])) $this->IsMVP = $o['IsMVP'];
        if (isset($o['IsRVP'])) $this->IsRVP = $o['IsRVP'];
        if (isset($o['IsAVP'])) $this->IsAVP = $o['IsAVP'];
        if (isset($o['PolicyCount'])) $this->PolicyCount = $o['PolicyCount'];
        if (isset($o['AppCount'])) $this->AppCount = $o['AppCount'];
        if (isset($o['Points'])) $this->Points = $o['Points'];
        if (isset($o['Cashflow'])) $this->Cashflow = $o['Cashflow'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->MVPID)) $o['MVPID'] = $this->MVPID;
        if (isset($this->AVPID)) $o['AVPID'] = $this->AVPID;
        if (isset($this->RVPID)) $o['RVPID'] = $this->RVPID;
        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->AgentLevel)) $o['AgentLevel'] = $this->AgentLevel;
        if (isset($this->Rank)) $o['Rank'] = $this->Rank;
        if (isset($this->FullName)) $o['FullName'] = $this->FullName;
        if (isset($this->IsMVP)) $o['IsMVP'] = $this->IsMVP;
        if (isset($this->IsRVP)) $o['IsRVP'] = $this->IsRVP;
        if (isset($this->IsAVP)) $o['IsAVP'] = $this->IsAVP;
        if (isset($this->PolicyCount)) $o['PolicyCount'] = $this->PolicyCount;
        if (isset($this->AppCount)) $o['AppCount'] = $this->AppCount;
        if (isset($this->Points)) $o['Points'] = $this->Points;
        if (isset($this->Cashflow)) $o['Cashflow'] = $this->Cashflow;
        return empty($o) ? new class(){} : $o;
    }
}

class ProductionResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Production>|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('Production', $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('Production', $this->ReportData);
        return empty($o) ? new class(){} : $o;
    }
}

class ProductionRequest 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 ProductionRequest DTOs

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

HTTP + JSV

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

GET /v1/Production HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ReportData: 
	[
		{
			AgentId: 0,
			MVPID: 0,
			AVPID: 0,
			RVPID: 0,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			AgentLevel: 0,
			Rank: String,
			FullName: String,
			IsMVP: False,
			IsRVP: False,
			IsAVP: False,
			PolicyCount: 0,
			AppCount: 0,
			Points: 0,
			Cashflow: 0
		}
	]
}