| Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/{ID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate} |
<?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 ListingSummary implements JsonSerializable
{
public function __construct(
/** @var float */
public float $AgentLevel=0.0,
/** @var string|null */
public ?string $AgentPoints=null,
/** @var string|null */
public ?string $AgentPolicyNumbers=null,
/** @var float */
public float $AgentYTDTotal=0.0,
/** @var float */
public float $AgentRTotal=0.0,
/** @var float */
public float $AgentOverallTotal=0.0,
/** @var float */
public float $AgentNextLevelPrerequired=0.0,
/** @var float */
public float $AgentCurrentYTDTotal=0.0,
/** @var float */
public float $AgentCurrentRunningTotal=0.0,
/** @var float */
public float $AgentLevelCalculatedFromListingPart=0.0,
/** @var float */
public float $AgentRequiredBeforeNextLevel=0.0,
/** @var float */
public float $AgentAdjustmentTotal=0.0,
/** @var float */
public float $AgentCommissionSubtotal=0.0,
/** @var float */
public float $AgentBalanceForward=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgentLevel'])) $this->AgentLevel = $o['AgentLevel'];
if (isset($o['AgentPoints'])) $this->AgentPoints = $o['AgentPoints'];
if (isset($o['AgentPolicyNumbers'])) $this->AgentPolicyNumbers = $o['AgentPolicyNumbers'];
if (isset($o['AgentYTDTotal'])) $this->AgentYTDTotal = $o['AgentYTDTotal'];
if (isset($o['AgentRTotal'])) $this->AgentRTotal = $o['AgentRTotal'];
if (isset($o['AgentOverallTotal'])) $this->AgentOverallTotal = $o['AgentOverallTotal'];
if (isset($o['AgentNextLevelPrerequired'])) $this->AgentNextLevelPrerequired = $o['AgentNextLevelPrerequired'];
if (isset($o['AgentCurrentYTDTotal'])) $this->AgentCurrentYTDTotal = $o['AgentCurrentYTDTotal'];
if (isset($o['AgentCurrentRunningTotal'])) $this->AgentCurrentRunningTotal = $o['AgentCurrentRunningTotal'];
if (isset($o['AgentLevelCalculatedFromListingPart'])) $this->AgentLevelCalculatedFromListingPart = $o['AgentLevelCalculatedFromListingPart'];
if (isset($o['AgentRequiredBeforeNextLevel'])) $this->AgentRequiredBeforeNextLevel = $o['AgentRequiredBeforeNextLevel'];
if (isset($o['AgentAdjustmentTotal'])) $this->AgentAdjustmentTotal = $o['AgentAdjustmentTotal'];
if (isset($o['AgentCommissionSubtotal'])) $this->AgentCommissionSubtotal = $o['AgentCommissionSubtotal'];
if (isset($o['AgentBalanceForward'])) $this->AgentBalanceForward = $o['AgentBalanceForward'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgentLevel)) $o['AgentLevel'] = $this->AgentLevel;
if (isset($this->AgentPoints)) $o['AgentPoints'] = $this->AgentPoints;
if (isset($this->AgentPolicyNumbers)) $o['AgentPolicyNumbers'] = $this->AgentPolicyNumbers;
if (isset($this->AgentYTDTotal)) $o['AgentYTDTotal'] = $this->AgentYTDTotal;
if (isset($this->AgentRTotal)) $o['AgentRTotal'] = $this->AgentRTotal;
if (isset($this->AgentOverallTotal)) $o['AgentOverallTotal'] = $this->AgentOverallTotal;
if (isset($this->AgentNextLevelPrerequired)) $o['AgentNextLevelPrerequired'] = $this->AgentNextLevelPrerequired;
if (isset($this->AgentCurrentYTDTotal)) $o['AgentCurrentYTDTotal'] = $this->AgentCurrentYTDTotal;
if (isset($this->AgentCurrentRunningTotal)) $o['AgentCurrentRunningTotal'] = $this->AgentCurrentRunningTotal;
if (isset($this->AgentLevelCalculatedFromListingPart)) $o['AgentLevelCalculatedFromListingPart'] = $this->AgentLevelCalculatedFromListingPart;
if (isset($this->AgentRequiredBeforeNextLevel)) $o['AgentRequiredBeforeNextLevel'] = $this->AgentRequiredBeforeNextLevel;
if (isset($this->AgentAdjustmentTotal)) $o['AgentAdjustmentTotal'] = $this->AgentAdjustmentTotal;
if (isset($this->AgentCommissionSubtotal)) $o['AgentCommissionSubtotal'] = $this->AgentCommissionSubtotal;
if (isset($this->AgentBalanceForward)) $o['AgentBalanceForward'] = $this->AgentBalanceForward;
return empty($o) ? new class(){} : $o;
}
}
class ListingSummaryResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<ListingSummary>|null */
public ?array $ListingSummary=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['ListingSummary'])) $this->ListingSummary = JsonConverters::fromArray('ListingSummary', $o['ListingSummary']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->ListingSummary)) $o['ListingSummary'] = JsonConverters::toArray('ListingSummary', $this->ListingSummary);
return empty($o) ? new class(){} : $o;
}
}
class ListingSummaryRequest implements JsonSerializable
{
public function __construct(
/** @var array<ListingSummary>|null */
public ?array $ListingSummary=null,
/** @var int */
public int $AgentID=0,
/** @var DateTime */
public DateTime $ParamStartDate=new DateTime(),
/** @var DateTime */
public DateTime $ParamEndDate=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ListingSummary'])) $this->ListingSummary = JsonConverters::fromArray('ListingSummary', $o['ListingSummary']);
if (isset($o['AgentID'])) $this->AgentID = $o['AgentID'];
if (isset($o['ParamStartDate'])) $this->ParamStartDate = JsonConverters::from('DateTime', $o['ParamStartDate']);
if (isset($o['ParamEndDate'])) $this->ParamEndDate = JsonConverters::from('DateTime', $o['ParamEndDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ListingSummary)) $o['ListingSummary'] = JsonConverters::toArray('ListingSummary', $this->ListingSummary);
if (isset($this->AgentID)) $o['AgentID'] = $this->AgentID;
if (isset($this->ParamStartDate)) $o['ParamStartDate'] = JsonConverters::to('DateTime', $this->ParamStartDate);
if (isset($this->ParamEndDate)) $o['ParamEndDate'] = JsonConverters::to('DateTime', $this->ParamEndDate);
return empty($o) ? new class(){} : $o;
}
}
PHP ListingSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/ListingSummary/{ID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ListingSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentID>0</AgentID>
<ListingSummary>
<ListingSummary>
<AgentAdjustmentTotal>0</AgentAdjustmentTotal>
<AgentBalanceForward>0</AgentBalanceForward>
<AgentCommissionSubtotal>0</AgentCommissionSubtotal>
<AgentCurrentRunningTotal>0</AgentCurrentRunningTotal>
<AgentCurrentYTDTotal>0</AgentCurrentYTDTotal>
<AgentLevel>0</AgentLevel>
<AgentLevelCalculatedFromListingPart>0</AgentLevelCalculatedFromListingPart>
<AgentNextLevelPrerequired>0</AgentNextLevelPrerequired>
<AgentOverallTotal>0</AgentOverallTotal>
<AgentPoints>String</AgentPoints>
<AgentPolicyNumbers>String</AgentPolicyNumbers>
<AgentRTotal>0</AgentRTotal>
<AgentRequiredBeforeNextLevel>0</AgentRequiredBeforeNextLevel>
<AgentYTDTotal>0</AgentYTDTotal>
</ListingSummary>
</ListingSummary>
<ParamEndDate>0001-01-01T00:00:00</ParamEndDate>
<ParamStartDate>0001-01-01T00:00:00</ParamStartDate>
</ListingSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListingSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ListingSummary>
<ListingSummary>
<AgentAdjustmentTotal>0</AgentAdjustmentTotal>
<AgentBalanceForward>0</AgentBalanceForward>
<AgentCommissionSubtotal>0</AgentCommissionSubtotal>
<AgentCurrentRunningTotal>0</AgentCurrentRunningTotal>
<AgentCurrentYTDTotal>0</AgentCurrentYTDTotal>
<AgentLevel>0</AgentLevel>
<AgentLevelCalculatedFromListingPart>0</AgentLevelCalculatedFromListingPart>
<AgentNextLevelPrerequired>0</AgentNextLevelPrerequired>
<AgentOverallTotal>0</AgentOverallTotal>
<AgentPoints>String</AgentPoints>
<AgentPolicyNumbers>String</AgentPolicyNumbers>
<AgentRTotal>0</AgentRTotal>
<AgentRequiredBeforeNextLevel>0</AgentRequiredBeforeNextLevel>
<AgentYTDTotal>0</AgentYTDTotal>
</ListingSummary>
</ListingSummary>
<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>
</ListingSummaryResponse>