Trendsic Platform Service

<back to all web services

EstimateRevisionCompareRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB}
<?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 RevisionLineDelta implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ItemNo=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Unit=null,
        /** @var string|null */
        public ?string $Change=null,
        /** @var float|null */
        public ?float $QuantityA=null,
        /** @var float|null */
        public ?float $QuantityB=null,
        /** @var float|null */
        public ?float $UnitPriceA=null,
        /** @var float|null */
        public ?float $UnitPriceB=null,
        /** @var float */
        public float $ExtensionA=0.0,
        /** @var float */
        public float $ExtensionB=0.0,
        /** @var float */
        public float $QuantityDelta=0.0,
        /** @var float */
        public float $UnitPriceDelta=0.0,
        /** @var float */
        public float $ExtensionDelta=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ItemNo'])) $this->ItemNo = $o['ItemNo'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Unit'])) $this->Unit = $o['Unit'];
        if (isset($o['Change'])) $this->Change = $o['Change'];
        if (isset($o['QuantityA'])) $this->QuantityA = $o['QuantityA'];
        if (isset($o['QuantityB'])) $this->QuantityB = $o['QuantityB'];
        if (isset($o['UnitPriceA'])) $this->UnitPriceA = $o['UnitPriceA'];
        if (isset($o['UnitPriceB'])) $this->UnitPriceB = $o['UnitPriceB'];
        if (isset($o['ExtensionA'])) $this->ExtensionA = $o['ExtensionA'];
        if (isset($o['ExtensionB'])) $this->ExtensionB = $o['ExtensionB'];
        if (isset($o['QuantityDelta'])) $this->QuantityDelta = $o['QuantityDelta'];
        if (isset($o['UnitPriceDelta'])) $this->UnitPriceDelta = $o['UnitPriceDelta'];
        if (isset($o['ExtensionDelta'])) $this->ExtensionDelta = $o['ExtensionDelta'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ItemNo)) $o['ItemNo'] = $this->ItemNo;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Unit)) $o['Unit'] = $this->Unit;
        if (isset($this->Change)) $o['Change'] = $this->Change;
        if (isset($this->QuantityA)) $o['QuantityA'] = $this->QuantityA;
        if (isset($this->QuantityB)) $o['QuantityB'] = $this->QuantityB;
        if (isset($this->UnitPriceA)) $o['UnitPriceA'] = $this->UnitPriceA;
        if (isset($this->UnitPriceB)) $o['UnitPriceB'] = $this->UnitPriceB;
        if (isset($this->ExtensionA)) $o['ExtensionA'] = $this->ExtensionA;
        if (isset($this->ExtensionB)) $o['ExtensionB'] = $this->ExtensionB;
        if (isset($this->QuantityDelta)) $o['QuantityDelta'] = $this->QuantityDelta;
        if (isset($this->UnitPriceDelta)) $o['UnitPriceDelta'] = $this->UnitPriceDelta;
        if (isset($this->ExtensionDelta)) $o['ExtensionDelta'] = $this->ExtensionDelta;
        return empty($o) ? new class(){} : $o;
    }
}

class TaskDiff implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TaskName=null,
        /** @var array<string>|null */
        public ?array $PositionsAdded=null,
        /** @var array<string>|null */
        public ?array $PositionsRemoved=null,
        /** @var array<string>|null */
        public ?array $PositionsStaffed=null,
        /** @var array<int>|null */
        public ?array $EquipmentAdded=null,
        /** @var array<int>|null */
        public ?array $EquipmentRemoved=null,
        /** @var array<int>|null */
        public ?array $MaterialsAdded=null,
        /** @var array<int>|null */
        public ?array $MaterialsRemoved=null,
        /** @var bool|null */
        public ?bool $HasChanges=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TaskName'])) $this->TaskName = $o['TaskName'];
        if (isset($o['PositionsAdded'])) $this->PositionsAdded = JsonConverters::fromArray('string', $o['PositionsAdded']);
        if (isset($o['PositionsRemoved'])) $this->PositionsRemoved = JsonConverters::fromArray('string', $o['PositionsRemoved']);
        if (isset($o['PositionsStaffed'])) $this->PositionsStaffed = JsonConverters::fromArray('string', $o['PositionsStaffed']);
        if (isset($o['EquipmentAdded'])) $this->EquipmentAdded = JsonConverters::fromArray('int', $o['EquipmentAdded']);
        if (isset($o['EquipmentRemoved'])) $this->EquipmentRemoved = JsonConverters::fromArray('int', $o['EquipmentRemoved']);
        if (isset($o['MaterialsAdded'])) $this->MaterialsAdded = JsonConverters::fromArray('int', $o['MaterialsAdded']);
        if (isset($o['MaterialsRemoved'])) $this->MaterialsRemoved = JsonConverters::fromArray('int', $o['MaterialsRemoved']);
        if (isset($o['HasChanges'])) $this->HasChanges = $o['HasChanges'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TaskName)) $o['TaskName'] = $this->TaskName;
        if (isset($this->PositionsAdded)) $o['PositionsAdded'] = JsonConverters::toArray('string', $this->PositionsAdded);
        if (isset($this->PositionsRemoved)) $o['PositionsRemoved'] = JsonConverters::toArray('string', $this->PositionsRemoved);
        if (isset($this->PositionsStaffed)) $o['PositionsStaffed'] = JsonConverters::toArray('string', $this->PositionsStaffed);
        if (isset($this->EquipmentAdded)) $o['EquipmentAdded'] = JsonConverters::toArray('int', $this->EquipmentAdded);
        if (isset($this->EquipmentRemoved)) $o['EquipmentRemoved'] = JsonConverters::toArray('int', $this->EquipmentRemoved);
        if (isset($this->MaterialsAdded)) $o['MaterialsAdded'] = JsonConverters::toArray('int', $this->MaterialsAdded);
        if (isset($this->MaterialsRemoved)) $o['MaterialsRemoved'] = JsonConverters::toArray('int', $this->MaterialsRemoved);
        if (isset($this->HasChanges)) $o['HasChanges'] = $this->HasChanges;
        return empty($o) ? new class(){} : $o;
    }
}

class ProposalDiff implements JsonSerializable
{
    public function __construct(
        /** @var array<string>|null */
        public ?array $TasksAdded=null,
        /** @var array<string>|null */
        public ?array $TasksRemoved=null,
        /** @var array<TaskDiff>|null */
        public ?array $Tasks=null,
        /** @var bool|null */
        public ?bool $HasChanges=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TasksAdded'])) $this->TasksAdded = JsonConverters::fromArray('string', $o['TasksAdded']);
        if (isset($o['TasksRemoved'])) $this->TasksRemoved = JsonConverters::fromArray('string', $o['TasksRemoved']);
        if (isset($o['Tasks'])) $this->Tasks = JsonConverters::fromArray('TaskDiff', $o['Tasks']);
        if (isset($o['HasChanges'])) $this->HasChanges = $o['HasChanges'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TasksAdded)) $o['TasksAdded'] = JsonConverters::toArray('string', $this->TasksAdded);
        if (isset($this->TasksRemoved)) $o['TasksRemoved'] = JsonConverters::toArray('string', $this->TasksRemoved);
        if (isset($this->Tasks)) $o['Tasks'] = JsonConverters::toArray('TaskDiff', $this->Tasks);
        if (isset($this->HasChanges)) $o['HasChanges'] = $this->HasChanges;
        return empty($o) ? new class(){} : $o;
    }
}

class EstimateRevisionCompareResult implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $RevisionA=0,
        /** @var int */
        public int $RevisionB=0,
        /** @var string|null */
        public ?string $LabelA=null,
        /** @var string|null */
        public ?string $LabelB=null,
        /** @var float */
        public float $TotalA=0.0,
        /** @var float */
        public float $TotalB=0.0,
        /** @var float */
        public float $TotalDelta=0.0,
        /** @var float */
        public float $BidTotalA=0.0,
        /** @var float */
        public float $BidTotalB=0.0,
        /** @var int */
        public int $Added=0,
        /** @var int */
        public int $Removed=0,
        /** @var int */
        public int $Changed=0,
        /** @var int */
        public int $Unchanged=0,
        /** @var array<RevisionLineDelta>|null */
        public ?array $Lines=null,
        /** @var ProposalDiff|null */
        public ?ProposalDiff $Scope=null,
        /** @var string|null */
        public ?string $Summary=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RevisionA'])) $this->RevisionA = $o['RevisionA'];
        if (isset($o['RevisionB'])) $this->RevisionB = $o['RevisionB'];
        if (isset($o['LabelA'])) $this->LabelA = $o['LabelA'];
        if (isset($o['LabelB'])) $this->LabelB = $o['LabelB'];
        if (isset($o['TotalA'])) $this->TotalA = $o['TotalA'];
        if (isset($o['TotalB'])) $this->TotalB = $o['TotalB'];
        if (isset($o['TotalDelta'])) $this->TotalDelta = $o['TotalDelta'];
        if (isset($o['BidTotalA'])) $this->BidTotalA = $o['BidTotalA'];
        if (isset($o['BidTotalB'])) $this->BidTotalB = $o['BidTotalB'];
        if (isset($o['Added'])) $this->Added = $o['Added'];
        if (isset($o['Removed'])) $this->Removed = $o['Removed'];
        if (isset($o['Changed'])) $this->Changed = $o['Changed'];
        if (isset($o['Unchanged'])) $this->Unchanged = $o['Unchanged'];
        if (isset($o['Lines'])) $this->Lines = JsonConverters::fromArray('RevisionLineDelta', $o['Lines']);
        if (isset($o['Scope'])) $this->Scope = JsonConverters::from('ProposalDiff', $o['Scope']);
        if (isset($o['Summary'])) $this->Summary = $o['Summary'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RevisionA)) $o['RevisionA'] = $this->RevisionA;
        if (isset($this->RevisionB)) $o['RevisionB'] = $this->RevisionB;
        if (isset($this->LabelA)) $o['LabelA'] = $this->LabelA;
        if (isset($this->LabelB)) $o['LabelB'] = $this->LabelB;
        if (isset($this->TotalA)) $o['TotalA'] = $this->TotalA;
        if (isset($this->TotalB)) $o['TotalB'] = $this->TotalB;
        if (isset($this->TotalDelta)) $o['TotalDelta'] = $this->TotalDelta;
        if (isset($this->BidTotalA)) $o['BidTotalA'] = $this->BidTotalA;
        if (isset($this->BidTotalB)) $o['BidTotalB'] = $this->BidTotalB;
        if (isset($this->Added)) $o['Added'] = $this->Added;
        if (isset($this->Removed)) $o['Removed'] = $this->Removed;
        if (isset($this->Changed)) $o['Changed'] = $this->Changed;
        if (isset($this->Unchanged)) $o['Unchanged'] = $this->Unchanged;
        if (isset($this->Lines)) $o['Lines'] = JsonConverters::toArray('RevisionLineDelta', $this->Lines);
        if (isset($this->Scope)) $o['Scope'] = JsonConverters::to('ProposalDiff', $this->Scope);
        if (isset($this->Summary)) $o['Summary'] = $this->Summary;
        return empty($o) ? new class(){} : $o;
    }
}

class EstimateRevisionCompareResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var EstimateRevisionCompareResult|null */
        public ?EstimateRevisionCompareResult $Compare=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Compare'])) $this->Compare = JsonConverters::from('EstimateRevisionCompareResult', $o['Compare']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Compare)) $o['Compare'] = JsonConverters::to('EstimateRevisionCompareResult', $this->Compare);
        return empty($o) ? new class(){} : $o;
    }
}

class EstimateRevisionCompareRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $RfpDocumentUID='',
        /** @var int */
        public int $RevisionA=0,
        /** @var int */
        public int $RevisionB=0
    ) {
    }

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

PHP EstimateRevisionCompareRequest DTOs

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

HTTP + JSON

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

GET /v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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"}},"Compare":{"RevisionA":0,"RevisionB":0,"LabelA":"String","LabelB":"String","TotalA":0,"TotalB":0,"TotalDelta":0,"BidTotalA":0,"BidTotalB":0,"Added":0,"Removed":0,"Changed":0,"Unchanged":0,"Lines":[{"ItemNo":"String","Description":"String","Unit":"String","Change":"String","QuantityA":0,"QuantityB":0,"UnitPriceA":0,"UnitPriceB":0,"ExtensionA":0,"ExtensionB":0,"QuantityDelta":0,"UnitPriceDelta":0,"ExtensionDelta":0}],"Scope":{"TasksAdded":["String"],"TasksRemoved":["String"],"Tasks":[{"TaskName":"String","PositionsAdded":["String"],"PositionsRemoved":["String"],"PositionsStaffed":["String"],"EquipmentAdded":[0],"EquipmentRemoved":[0],"MaterialsAdded":[0],"MaterialsRemoved":[0],"HasChanges":true}],"HasChanges":true},"Summary":"String"}}