| POST,OPTIONS | /v1/dashboard/finance |
|---|
<?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 DashboardSeriesPoint implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Label=null,
/** @var float */
public float $Value=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['Value'])) $this->Value = $o['Value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->Value)) $o['Value'] = $this->Value;
return empty($o) ? new class(){} : $o;
}
}
class DashboardSeries implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var array<DashboardSeriesPoint>|null */
public ?array $Points=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Points'])) $this->Points = JsonConverters::fromArray('DashboardSeriesPoint', $o['Points']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Points)) $o['Points'] = JsonConverters::toArray('DashboardSeriesPoint', $this->Points);
return empty($o) ? new class(){} : $o;
}
}
class FinanceLocationRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $LocationName=null,
/** @var float */
public float $ServiceRev=0.0,
/** @var float */
public float $ProductRev=0.0,
/** @var float */
public float $SubscriptionRev=0.0,
/** @var float */
public float $Total=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LocationName'])) $this->LocationName = $o['LocationName'];
if (isset($o['ServiceRev'])) $this->ServiceRev = $o['ServiceRev'];
if (isset($o['ProductRev'])) $this->ProductRev = $o['ProductRev'];
if (isset($o['SubscriptionRev'])) $this->SubscriptionRev = $o['SubscriptionRev'];
if (isset($o['Total'])) $this->Total = $o['Total'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LocationName)) $o['LocationName'] = $this->LocationName;
if (isset($this->ServiceRev)) $o['ServiceRev'] = $this->ServiceRev;
if (isset($this->ProductRev)) $o['ProductRev'] = $this->ProductRev;
if (isset($this->SubscriptionRev)) $o['SubscriptionRev'] = $this->SubscriptionRev;
if (isset($this->Total)) $o['Total'] = $this->Total;
return empty($o) ? new class(){} : $o;
}
}
class FinanceTopRow implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var float */
public float $Revenue=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Revenue'])) $this->Revenue = $o['Revenue'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Revenue)) $o['Revenue'] = $this->Revenue;
return empty($o) ? new class(){} : $o;
}
}
class FinanceSubscriptionInfo implements JsonSerializable
{
public function __construct(
/** @var float */
public float $Mrr=0.0,
/** @var float */
public float $Arr=0.0,
/** @var int */
public int $ActiveCount=0,
/** @var int */
public int $NewCount=0,
/** @var int */
public int $ChurnedCount=0,
/** @var float */
public float $ChurnRatePct=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Mrr'])) $this->Mrr = $o['Mrr'];
if (isset($o['Arr'])) $this->Arr = $o['Arr'];
if (isset($o['ActiveCount'])) $this->ActiveCount = $o['ActiveCount'];
if (isset($o['NewCount'])) $this->NewCount = $o['NewCount'];
if (isset($o['ChurnedCount'])) $this->ChurnedCount = $o['ChurnedCount'];
if (isset($o['ChurnRatePct'])) $this->ChurnRatePct = $o['ChurnRatePct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Mrr)) $o['Mrr'] = $this->Mrr;
if (isset($this->Arr)) $o['Arr'] = $this->Arr;
if (isset($this->ActiveCount)) $o['ActiveCount'] = $this->ActiveCount;
if (isset($this->NewCount)) $o['NewCount'] = $this->NewCount;
if (isset($this->ChurnedCount)) $o['ChurnedCount'] = $this->ChurnedCount;
if (isset($this->ChurnRatePct)) $o['ChurnRatePct'] = $this->ChurnRatePct;
return empty($o) ? new class(){} : $o;
}
}
class FinanceResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<DashboardStatTile>|null */
public ?array $Stats=null,
/** @var array<DashboardSeries>|null */
public ?array $Trend=null,
/** @var DashboardSeries|null */
public ?DashboardSeries $SourceMix=null,
/** @var array<FinanceLocationRow>|null */
public ?array $ByLocation=null,
/** @var array<FinanceTopRow>|null */
public ?array $TopServices=null,
/** @var array<FinanceTopRow>|null */
public ?array $TopProducts=null,
/** @var FinanceSubscriptionInfo|null */
public ?FinanceSubscriptionInfo $Subscriptions=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['Trend'])) $this->Trend = JsonConverters::fromArray('DashboardSeries', $o['Trend']);
if (isset($o['SourceMix'])) $this->SourceMix = JsonConverters::from('DashboardSeries', $o['SourceMix']);
if (isset($o['ByLocation'])) $this->ByLocation = JsonConverters::fromArray('FinanceLocationRow', $o['ByLocation']);
if (isset($o['TopServices'])) $this->TopServices = JsonConverters::fromArray('FinanceTopRow', $o['TopServices']);
if (isset($o['TopProducts'])) $this->TopProducts = JsonConverters::fromArray('FinanceTopRow', $o['TopProducts']);
if (isset($o['Subscriptions'])) $this->Subscriptions = JsonConverters::from('FinanceSubscriptionInfo', $o['Subscriptions']);
}
/** @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->Trend)) $o['Trend'] = JsonConverters::toArray('DashboardSeries', $this->Trend);
if (isset($this->SourceMix)) $o['SourceMix'] = JsonConverters::to('DashboardSeries', $this->SourceMix);
if (isset($this->ByLocation)) $o['ByLocation'] = JsonConverters::toArray('FinanceLocationRow', $this->ByLocation);
if (isset($this->TopServices)) $o['TopServices'] = JsonConverters::toArray('FinanceTopRow', $this->TopServices);
if (isset($this->TopProducts)) $o['TopProducts'] = JsonConverters::toArray('FinanceTopRow', $this->TopProducts);
if (isset($this->Subscriptions)) $o['Subscriptions'] = JsonConverters::to('FinanceSubscriptionInfo', $this->Subscriptions);
return empty($o) ? new class(){} : $o;
}
}
class FinanceRequest 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 .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/dashboard/finance HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FromDate>0001-01-01T00:00:00</FromDate>
<LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LocationIds>
<ToDate>0001-01-01T00:00:00</ToDate>
</FinanceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ByLocation>
<FinanceLocationRow>
<LocationName>String</LocationName>
<ProductRev>0</ProductRev>
<ServiceRev>0</ServiceRev>
<SubscriptionRev>0</SubscriptionRev>
<Total>0</Total>
</FinanceLocationRow>
</ByLocation>
<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>
<SourceMix>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</SourceMix>
<Stats>
<DashboardStatTile>
<Key>String</Key>
<Label>String</Label>
<PreviousValue>0</PreviousValue>
<Unit>String</Unit>
<Value>0</Value>
</DashboardStatTile>
</Stats>
<Subscriptions>
<ActiveCount>0</ActiveCount>
<Arr>0</Arr>
<ChurnRatePct>0</ChurnRatePct>
<ChurnedCount>0</ChurnedCount>
<Mrr>0</Mrr>
<NewCount>0</NewCount>
</Subscriptions>
<TopProducts>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopProducts>
<TopServices>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopServices>
<Trend>
<DashboardSeries>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</DashboardSeries>
</Trend>
</FinanceResponse>