Trendsic Platform Service

<back to all web services

ComparablesRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Comparables
<?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 ComparableLettingView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ProjectNumber=null,
        /** @var DateTime */
        public DateTime $LettingDate=new DateTime(),
        /** @var float */
        public float $AgeYears=0.0,
        /** @var string|null */
        public ?string $Parish=null,
        /** @var string|null */
        public ?string $LettingUrl=null,
        /** @var float */
        public float $WinnerTotal=0.0,
        /** @var float|null */
        public ?float $SpreadPct=null,
        /** @var int */
        public int $BidderCount=0,
        /** @var int */
        public int $SharedCount=0,
        /** @var int */
        public int $ItemCount=0,
        /** @var float */
        public float $OverlapPct=0.0,
        /** @var float|null */
        public ?float $MobilizationPct=null,
        /** @var float|null */
        public ?float $TrafficControlPct=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectNumber'])) $this->ProjectNumber = $o['ProjectNumber'];
        if (isset($o['LettingDate'])) $this->LettingDate = JsonConverters::from('DateTime', $o['LettingDate']);
        if (isset($o['AgeYears'])) $this->AgeYears = $o['AgeYears'];
        if (isset($o['Parish'])) $this->Parish = $o['Parish'];
        if (isset($o['LettingUrl'])) $this->LettingUrl = $o['LettingUrl'];
        if (isset($o['WinnerTotal'])) $this->WinnerTotal = $o['WinnerTotal'];
        if (isset($o['SpreadPct'])) $this->SpreadPct = $o['SpreadPct'];
        if (isset($o['BidderCount'])) $this->BidderCount = $o['BidderCount'];
        if (isset($o['SharedCount'])) $this->SharedCount = $o['SharedCount'];
        if (isset($o['ItemCount'])) $this->ItemCount = $o['ItemCount'];
        if (isset($o['OverlapPct'])) $this->OverlapPct = $o['OverlapPct'];
        if (isset($o['MobilizationPct'])) $this->MobilizationPct = $o['MobilizationPct'];
        if (isset($o['TrafficControlPct'])) $this->TrafficControlPct = $o['TrafficControlPct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectNumber)) $o['ProjectNumber'] = $this->ProjectNumber;
        if (isset($this->LettingDate)) $o['LettingDate'] = JsonConverters::to('DateTime', $this->LettingDate);
        if (isset($this->AgeYears)) $o['AgeYears'] = $this->AgeYears;
        if (isset($this->Parish)) $o['Parish'] = $this->Parish;
        if (isset($this->LettingUrl)) $o['LettingUrl'] = $this->LettingUrl;
        if (isset($this->WinnerTotal)) $o['WinnerTotal'] = $this->WinnerTotal;
        if (isset($this->SpreadPct)) $o['SpreadPct'] = $this->SpreadPct;
        if (isset($this->BidderCount)) $o['BidderCount'] = $this->BidderCount;
        if (isset($this->SharedCount)) $o['SharedCount'] = $this->SharedCount;
        if (isset($this->ItemCount)) $o['ItemCount'] = $this->ItemCount;
        if (isset($this->OverlapPct)) $o['OverlapPct'] = $this->OverlapPct;
        if (isset($this->MobilizationPct)) $o['MobilizationPct'] = $this->MobilizationPct;
        if (isset($this->TrafficControlPct)) $o['TrafficControlPct'] = $this->TrafficControlPct;
        return empty($o) ? new class(){} : $o;
    }
}

class ComparablesSummaryView implements JsonSerializable
{
    public function __construct(
        /** @var float|null */
        public ?float $MedianMobilizationPct=null,
        /** @var float|null */
        public ?float $MedianTrafficControlPct=null,
        /** @var float|null */
        public ?float $MedianSpreadPct=null,
        /** @var float|null */
        public ?float $AppliedMobilizationPct=null,
        /** @var string|null */
        public ?string $Note=null
    ) {
    }

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

class ComparablesResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<ComparableLettingView>|null */
        public ?array $Comparables=null,
        /** @var ComparablesSummaryView|null */
        public ?ComparablesSummaryView $Summary=null
    ) {
    }

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

class ComparablesRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $RfpDocumentUID=''
    ) {
    }

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

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

GET /v1/Rfp/{RfpDocumentUID}/Comparables HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ComparablesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Comparables>
    <ComparableLettingView>
      <AgeYears>0</AgeYears>
      <BidderCount>0</BidderCount>
      <ItemCount>0</ItemCount>
      <LettingDate>0001-01-01T00:00:00</LettingDate>
      <LettingUrl>String</LettingUrl>
      <MobilizationPct>0</MobilizationPct>
      <OverlapPct>0</OverlapPct>
      <Parish>String</Parish>
      <ProjectNumber>String</ProjectNumber>
      <SharedCount>0</SharedCount>
      <SpreadPct>0</SpreadPct>
      <TrafficControlPct>0</TrafficControlPct>
      <WinnerTotal>0</WinnerTotal>
    </ComparableLettingView>
  </Comparables>
  <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>
  <Summary>
    <AppliedMobilizationPct>0</AppliedMobilizationPct>
    <MedianMobilizationPct>0</MedianMobilizationPct>
    <MedianSpreadPct>0</MedianSpreadPct>
    <MedianTrafficControlPct>0</MedianTrafficControlPct>
    <Note>String</Note>
  </Summary>
</ComparablesResponse>