| Requires any of the roles: | Agent, Administrator |
| 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;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Comparables":[{"ProjectNumber":"String","LettingDate":"0001-01-01T00:00:00.0000000","AgeYears":0,"Parish":"String","LettingUrl":"String","WinnerTotal":0,"SpreadPct":0,"BidderCount":0,"SharedCount":0,"ItemCount":0,"OverlapPct":0,"MobilizationPct":0,"TrafficControlPct":0}],"Summary":{"MedianMobilizationPct":0,"MedianTrafficControlPct":0,"MedianSpreadPct":0,"AppliedMobilizationPct":0,"Note":"String"}}