| POST,OPTIONS | /v1/dashboard/agreements |
|---|
<?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 DashboardStatTile implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Key=null,
/** @var string|null */
public ?string $Label=null,
/** @var float */
public float $Value=0.0,
/** @var float|null */
public ?float $PreviousValue=null,
/** @var string|null */
public ?string $Unit=null,
/** @var float|null */
public ?float $DeltaPct=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['Value'])) $this->Value = $o['Value'];
if (isset($o['PreviousValue'])) $this->PreviousValue = $o['PreviousValue'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['DeltaPct'])) $this->DeltaPct = $o['DeltaPct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->Value)) $o['Value'] = $this->Value;
if (isset($this->PreviousValue)) $o['PreviousValue'] = $this->PreviousValue;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->DeltaPct)) $o['DeltaPct'] = $this->DeltaPct;
return empty($o) ? new class(){} : $o;
}
}
class AgreementKpiBranchRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $BranchName=null,
/** @var int */
public int $ActiveCount=0,
/** @var float */
public float $Mrr=0.0,
/** @var int */
public int $ExpiringCount=0,
/** @var int */
public int $ChurnCount=0,
/** @var float */
public float $SkippedRate=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BranchName'])) $this->BranchName = $o['BranchName'];
if (isset($o['ActiveCount'])) $this->ActiveCount = $o['ActiveCount'];
if (isset($o['Mrr'])) $this->Mrr = $o['Mrr'];
if (isset($o['ExpiringCount'])) $this->ExpiringCount = $o['ExpiringCount'];
if (isset($o['ChurnCount'])) $this->ChurnCount = $o['ChurnCount'];
if (isset($o['SkippedRate'])) $this->SkippedRate = $o['SkippedRate'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BranchName)) $o['BranchName'] = $this->BranchName;
if (isset($this->ActiveCount)) $o['ActiveCount'] = $this->ActiveCount;
if (isset($this->Mrr)) $o['Mrr'] = $this->Mrr;
if (isset($this->ExpiringCount)) $o['ExpiringCount'] = $this->ExpiringCount;
if (isset($this->ChurnCount)) $o['ChurnCount'] = $this->ChurnCount;
if (isset($this->SkippedRate)) $o['SkippedRate'] = $this->SkippedRate;
return empty($o) ? new class(){} : $o;
}
}
class AgreementKpiResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<DashboardStatTile>|null */
public ?array $Stats=null,
/** @var array<AgreementKpiBranchRow>|null */
public ?array $ByBranch=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Stats'])) $this->Stats = JsonConverters::fromArray('DashboardStatTile', $o['Stats']);
if (isset($o['ByBranch'])) $this->ByBranch = JsonConverters::fromArray('AgreementKpiBranchRow', $o['ByBranch']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Stats)) $o['Stats'] = JsonConverters::toArray('DashboardStatTile', $this->Stats);
if (isset($this->ByBranch)) $o['ByBranch'] = JsonConverters::toArray('AgreementKpiBranchRow', $this->ByBranch);
return empty($o) ? new class(){} : $o;
}
}
class AgreementKpiRequest implements JsonSerializable
{
public function __construct(
/** @var DateTime */
public DateTime $FromDate=new DateTime(),
/** @var DateTime */
public DateTime $ToDate=new DateTime(),
/** @var array<string>|null */
public ?array $LocationIds=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FromDate'])) $this->FromDate = JsonConverters::from('DateTime', $o['FromDate']);
if (isset($o['ToDate'])) $this->ToDate = JsonConverters::from('DateTime', $o['ToDate']);
if (isset($o['LocationIds'])) $this->LocationIds = JsonConverters::fromArray('Guid', $o['LocationIds']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FromDate)) $o['FromDate'] = JsonConverters::to('DateTime', $this->FromDate);
if (isset($this->ToDate)) $o['ToDate'] = JsonConverters::to('DateTime', $this->ToDate);
if (isset($this->LocationIds)) $o['LocationIds'] = JsonConverters::toArray('Guid', $this->LocationIds);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dashboard/agreements HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Stats":[{"Key":"String","Label":"String","Value":0,"PreviousValue":0,"Unit":"String","DeltaPct":null}],"ByBranch":[{"BranchName":"String","ActiveCount":0,"Mrr":0,"ExpiringCount":0,"ChurnCount":0,"SkippedRate":0}]}