Trendsic Platform Service

<back to all web services

ProjectDashRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/project
<?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 ProjectDashOverdueRow implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ProjectName=null,
        /** @var string|null */
        public ?string $JobName=null,
        /** @var string|null */
        public ?string $ExpectedCompletionDate=null,
        /** @var int */
        public int $DaysOverdue=0,
        /** @var bool|null */
        public ?bool $IsAtRisk=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
        if (isset($o['JobName'])) $this->JobName = $o['JobName'];
        if (isset($o['ExpectedCompletionDate'])) $this->ExpectedCompletionDate = $o['ExpectedCompletionDate'];
        if (isset($o['DaysOverdue'])) $this->DaysOverdue = $o['DaysOverdue'];
        if (isset($o['IsAtRisk'])) $this->IsAtRisk = $o['IsAtRisk'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        if (isset($this->JobName)) $o['JobName'] = $this->JobName;
        if (isset($this->ExpectedCompletionDate)) $o['ExpectedCompletionDate'] = $this->ExpectedCompletionDate;
        if (isset($this->DaysOverdue)) $o['DaysOverdue'] = $this->DaysOverdue;
        if (isset($this->IsAtRisk)) $o['IsAtRisk'] = $this->IsAtRisk;
        return empty($o) ? new class(){} : $o;
    }
}

class ProjectDashRollupRow implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ProjectName=null,
        /** @var string|null */
        public ?string $StatusName=null,
        /** @var int */
        public int $JobCount=0,
        /** @var int */
        public int $CompletedJobCount=0,
        /** @var float */
        public float $TaskPct=0.0,
        /** @var float */
        public float $MilestonePct=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
        if (isset($o['StatusName'])) $this->StatusName = $o['StatusName'];
        if (isset($o['JobCount'])) $this->JobCount = $o['JobCount'];
        if (isset($o['CompletedJobCount'])) $this->CompletedJobCount = $o['CompletedJobCount'];
        if (isset($o['TaskPct'])) $this->TaskPct = $o['TaskPct'];
        if (isset($o['MilestonePct'])) $this->MilestonePct = $o['MilestonePct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        if (isset($this->StatusName)) $o['StatusName'] = $this->StatusName;
        if (isset($this->JobCount)) $o['JobCount'] = $this->JobCount;
        if (isset($this->CompletedJobCount)) $o['CompletedJobCount'] = $this->CompletedJobCount;
        if (isset($this->TaskPct)) $o['TaskPct'] = $this->TaskPct;
        if (isset($this->MilestonePct)) $o['MilestonePct'] = $this->MilestonePct;
        return empty($o) ? new class(){} : $o;
    }
}

class ProjectDashResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<DashboardStatTile>|null */
        public ?array $Stats=null,
        /** @var DashboardSeries|null */
        public ?DashboardSeries $JobStatus=null,
        /** @var DashboardSeries|null */
        public ?DashboardSeries $Throughput=null,
        /** @var DashboardSeries|null */
        public ?DashboardSeries $CycleDistribution=null,
        /** @var DashboardSeries|null */
        public ?DashboardSeries $Bottleneck=null,
        /** @var array<ProjectDashOverdueRow>|null */
        public ?array $OverdueJobs=null,
        /** @var array<ProjectDashRollupRow>|null */
        public ?array $Rollup=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['JobStatus'])) $this->JobStatus = JsonConverters::from('DashboardSeries', $o['JobStatus']);
        if (isset($o['Throughput'])) $this->Throughput = JsonConverters::from('DashboardSeries', $o['Throughput']);
        if (isset($o['CycleDistribution'])) $this->CycleDistribution = JsonConverters::from('DashboardSeries', $o['CycleDistribution']);
        if (isset($o['Bottleneck'])) $this->Bottleneck = JsonConverters::from('DashboardSeries', $o['Bottleneck']);
        if (isset($o['OverdueJobs'])) $this->OverdueJobs = JsonConverters::fromArray('ProjectDashOverdueRow', $o['OverdueJobs']);
        if (isset($o['Rollup'])) $this->Rollup = JsonConverters::fromArray('ProjectDashRollupRow', $o['Rollup']);
    }
    
    /** @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->JobStatus)) $o['JobStatus'] = JsonConverters::to('DashboardSeries', $this->JobStatus);
        if (isset($this->Throughput)) $o['Throughput'] = JsonConverters::to('DashboardSeries', $this->Throughput);
        if (isset($this->CycleDistribution)) $o['CycleDistribution'] = JsonConverters::to('DashboardSeries', $this->CycleDistribution);
        if (isset($this->Bottleneck)) $o['Bottleneck'] = JsonConverters::to('DashboardSeries', $this->Bottleneck);
        if (isset($this->OverdueJobs)) $o['OverdueJobs'] = JsonConverters::toArray('ProjectDashOverdueRow', $this->OverdueJobs);
        if (isset($this->Rollup)) $o['Rollup'] = JsonConverters::toArray('ProjectDashRollupRow', $this->Rollup);
        return empty($o) ? new class(){} : $o;
    }
}

class ProjectDashRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $FromDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ToDate=new DateTime()
    ) {
    }

    /** @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']);
    }
    
    /** @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);
        return empty($o) ? new class(){} : $o;
    }
}

PHP ProjectDashRequest 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.

POST /v1/dashboard/project HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProjectDashRequest 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>
  <ToDate>0001-01-01T00:00:00</ToDate>
</ProjectDashRequest>

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

<ProjectDashResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bottleneck>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Bottleneck>
  <CycleDistribution>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </CycleDistribution>
  <JobStatus>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </JobStatus>
  <OverdueJobs>
    <ProjectDashOverdueRow>
      <DaysOverdue>0</DaysOverdue>
      <ExpectedCompletionDate>String</ExpectedCompletionDate>
      <IsAtRisk>false</IsAtRisk>
      <JobName>String</JobName>
      <ProjectName>String</ProjectName>
    </ProjectDashOverdueRow>
  </OverdueJobs>
  <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>
  <Rollup>
    <ProjectDashRollupRow>
      <CompletedJobCount>0</CompletedJobCount>
      <JobCount>0</JobCount>
      <MilestonePct>0</MilestonePct>
      <ProjectName>String</ProjectName>
      <StatusName>String</StatusName>
      <TaskPct>0</TaskPct>
    </ProjectDashRollupRow>
  </Rollup>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Throughput>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </Throughput>
</ProjectDashResponse>