| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Pricing |
|---|
<?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 CostRange implements JsonSerializable
{
public function __construct(
/** @var float */
public float $Min=0.0,
/** @var float */
public float $Max=0.0,
/** @var float */
public float $Mid=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Min'])) $this->Min = $o['Min'];
if (isset($o['Max'])) $this->Max = $o['Max'];
if (isset($o['Mid'])) $this->Mid = $o['Mid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Min)) $o['Min'] = $this->Min;
if (isset($this->Max)) $o['Max'] = $this->Max;
if (isset($this->Mid)) $o['Mid'] = $this->Mid;
return empty($o) ? new class(){} : $o;
}
}
class PricedPosition implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PositionTag=null,
/** @var float */
public float $Hours=0.0,
/** @var bool|null */
public ?bool $HasInternalRate=null,
/** @var float|null */
public ?float $RateMin=null,
/** @var float|null */
public ?float $RateMax=null,
/** @var float|null */
public ?float $RateAvg=null,
/** @var int */
public int $ContactCount=0,
/** @var CostRange|null */
public ?CostRange $Cost=null,
/** @var float|null */
public ?float $MarketRateReference=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PositionTag'])) $this->PositionTag = $o['PositionTag'];
if (isset($o['Hours'])) $this->Hours = $o['Hours'];
if (isset($o['HasInternalRate'])) $this->HasInternalRate = $o['HasInternalRate'];
if (isset($o['RateMin'])) $this->RateMin = $o['RateMin'];
if (isset($o['RateMax'])) $this->RateMax = $o['RateMax'];
if (isset($o['RateAvg'])) $this->RateAvg = $o['RateAvg'];
if (isset($o['ContactCount'])) $this->ContactCount = $o['ContactCount'];
if (isset($o['Cost'])) $this->Cost = JsonConverters::from('CostRange', $o['Cost']);
if (isset($o['MarketRateReference'])) $this->MarketRateReference = $o['MarketRateReference'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PositionTag)) $o['PositionTag'] = $this->PositionTag;
if (isset($this->Hours)) $o['Hours'] = $this->Hours;
if (isset($this->HasInternalRate)) $o['HasInternalRate'] = $this->HasInternalRate;
if (isset($this->RateMin)) $o['RateMin'] = $this->RateMin;
if (isset($this->RateMax)) $o['RateMax'] = $this->RateMax;
if (isset($this->RateAvg)) $o['RateAvg'] = $this->RateAvg;
if (isset($this->ContactCount)) $o['ContactCount'] = $this->ContactCount;
if (isset($this->Cost)) $o['Cost'] = JsonConverters::to('CostRange', $this->Cost);
if (isset($this->MarketRateReference)) $o['MarketRateReference'] = $this->MarketRateReference;
return empty($o) ? new class(){} : $o;
}
}
class PricedEquipment implements JsonSerializable
{
public function __construct(
/** @var int */
public int $EquipmentID=0,
/** @var string|null */
public ?string $EquipmentName=null,
/** @var float */
public float $Quantity=0.0,
/** @var float|null */
public ?float $DurationDays=null,
/** @var string|null */
public ?string $RateType=null,
/** @var float|null */
public ?float $BilledRate=null,
/** @var float|null */
public ?float $CostRate=null,
/** @var bool|null */
public ?bool $HasRate=null,
/** @var bool|null */
public ?bool $IsInCatalog=null,
/** @var float */
public float $Cost=0.0,
/** @var float */
public float $CompanyCost=0.0,
/** @var float */
public float $Margin=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
if (isset($o['EquipmentName'])) $this->EquipmentName = $o['EquipmentName'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['DurationDays'])) $this->DurationDays = $o['DurationDays'];
if (isset($o['RateType'])) $this->RateType = $o['RateType'];
if (isset($o['BilledRate'])) $this->BilledRate = $o['BilledRate'];
if (isset($o['CostRate'])) $this->CostRate = $o['CostRate'];
if (isset($o['HasRate'])) $this->HasRate = $o['HasRate'];
if (isset($o['IsInCatalog'])) $this->IsInCatalog = $o['IsInCatalog'];
if (isset($o['Cost'])) $this->Cost = $o['Cost'];
if (isset($o['CompanyCost'])) $this->CompanyCost = $o['CompanyCost'];
if (isset($o['Margin'])) $this->Margin = $o['Margin'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
if (isset($this->EquipmentName)) $o['EquipmentName'] = $this->EquipmentName;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->DurationDays)) $o['DurationDays'] = $this->DurationDays;
if (isset($this->RateType)) $o['RateType'] = $this->RateType;
if (isset($this->BilledRate)) $o['BilledRate'] = $this->BilledRate;
if (isset($this->CostRate)) $o['CostRate'] = $this->CostRate;
if (isset($this->HasRate)) $o['HasRate'] = $this->HasRate;
if (isset($this->IsInCatalog)) $o['IsInCatalog'] = $this->IsInCatalog;
if (isset($this->Cost)) $o['Cost'] = $this->Cost;
if (isset($this->CompanyCost)) $o['CompanyCost'] = $this->CompanyCost;
if (isset($this->Margin)) $o['Margin'] = $this->Margin;
return empty($o) ? new class(){} : $o;
}
}
class PricedMaterial implements JsonSerializable
{
public function __construct(
/** @var int */
public int $MaterialID=0,
/** @var string|null */
public ?string $MaterialName=null,
/** @var float */
public float $Quantity=0.0,
/** @var float|null */
public ?float $UnitCost=null,
/** @var bool|null */
public ?bool $HasRate=null,
/** @var bool|null */
public ?bool $IsInCatalog=null,
/** @var float */
public float $Cost=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['MaterialID'])) $this->MaterialID = $o['MaterialID'];
if (isset($o['MaterialName'])) $this->MaterialName = $o['MaterialName'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['UnitCost'])) $this->UnitCost = $o['UnitCost'];
if (isset($o['HasRate'])) $this->HasRate = $o['HasRate'];
if (isset($o['IsInCatalog'])) $this->IsInCatalog = $o['IsInCatalog'];
if (isset($o['Cost'])) $this->Cost = $o['Cost'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->MaterialID)) $o['MaterialID'] = $this->MaterialID;
if (isset($this->MaterialName)) $o['MaterialName'] = $this->MaterialName;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->UnitCost)) $o['UnitCost'] = $this->UnitCost;
if (isset($this->HasRate)) $o['HasRate'] = $this->HasRate;
if (isset($this->IsInCatalog)) $o['IsInCatalog'] = $this->IsInCatalog;
if (isset($this->Cost)) $o['Cost'] = $this->Cost;
return empty($o) ? new class(){} : $o;
}
}
class PricedTask implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Category=null,
/** @var array<PricedPosition>|null */
public ?array $Positions=null,
/** @var array<PricedEquipment>|null */
public ?array $Equipment=null,
/** @var array<PricedMaterial>|null */
public ?array $Materials=null,
/** @var CostRange|null */
public ?CostRange $Subtotal=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Category'])) $this->Category = $o['Category'];
if (isset($o['Positions'])) $this->Positions = JsonConverters::fromArray('PricedPosition', $o['Positions']);
if (isset($o['Equipment'])) $this->Equipment = JsonConverters::fromArray('PricedEquipment', $o['Equipment']);
if (isset($o['Materials'])) $this->Materials = JsonConverters::fromArray('PricedMaterial', $o['Materials']);
if (isset($o['Subtotal'])) $this->Subtotal = JsonConverters::from('CostRange', $o['Subtotal']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Category)) $o['Category'] = $this->Category;
if (isset($this->Positions)) $o['Positions'] = JsonConverters::toArray('PricedPosition', $this->Positions);
if (isset($this->Equipment)) $o['Equipment'] = JsonConverters::toArray('PricedEquipment', $this->Equipment);
if (isset($this->Materials)) $o['Materials'] = JsonConverters::toArray('PricedMaterial', $this->Materials);
if (isset($this->Subtotal)) $o['Subtotal'] = JsonConverters::to('CostRange', $this->Subtotal);
return empty($o) ? new class(){} : $o;
}
}
class PricedProposal implements JsonSerializable
{
public function __construct(
/** @var int */
public int $RfpDocumentID=0,
/** @var string|null */
public ?string $ProjectName=null,
/** @var string|null */
public ?string $Currency=null,
/** @var array<PricedTask>|null */
public ?array $Tasks=null,
/** @var CostRange|null */
public ?CostRange $Total=null,
/** @var int */
public int $PositionsNeedingRate=0,
/** @var int */
public int $EquipmentNotInCatalog=0,
/** @var int */
public int $MaterialsNotInCatalog=0,
/** @var int */
public int $PositionsNotInCatalog=0,
/** @var float */
public float $EquipmentMargin=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RfpDocumentID'])) $this->RfpDocumentID = $o['RfpDocumentID'];
if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
if (isset($o['Currency'])) $this->Currency = $o['Currency'];
if (isset($o['Tasks'])) $this->Tasks = JsonConverters::fromArray('PricedTask', $o['Tasks']);
if (isset($o['Total'])) $this->Total = JsonConverters::from('CostRange', $o['Total']);
if (isset($o['PositionsNeedingRate'])) $this->PositionsNeedingRate = $o['PositionsNeedingRate'];
if (isset($o['EquipmentNotInCatalog'])) $this->EquipmentNotInCatalog = $o['EquipmentNotInCatalog'];
if (isset($o['MaterialsNotInCatalog'])) $this->MaterialsNotInCatalog = $o['MaterialsNotInCatalog'];
if (isset($o['PositionsNotInCatalog'])) $this->PositionsNotInCatalog = $o['PositionsNotInCatalog'];
if (isset($o['EquipmentMargin'])) $this->EquipmentMargin = $o['EquipmentMargin'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RfpDocumentID)) $o['RfpDocumentID'] = $this->RfpDocumentID;
if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
if (isset($this->Currency)) $o['Currency'] = $this->Currency;
if (isset($this->Tasks)) $o['Tasks'] = JsonConverters::toArray('PricedTask', $this->Tasks);
if (isset($this->Total)) $o['Total'] = JsonConverters::to('CostRange', $this->Total);
if (isset($this->PositionsNeedingRate)) $o['PositionsNeedingRate'] = $this->PositionsNeedingRate;
if (isset($this->EquipmentNotInCatalog)) $o['EquipmentNotInCatalog'] = $this->EquipmentNotInCatalog;
if (isset($this->MaterialsNotInCatalog)) $o['MaterialsNotInCatalog'] = $this->MaterialsNotInCatalog;
if (isset($this->PositionsNotInCatalog)) $o['PositionsNotInCatalog'] = $this->PositionsNotInCatalog;
if (isset($this->EquipmentMargin)) $o['EquipmentMargin'] = $this->EquipmentMargin;
return empty($o) ? new class(){} : $o;
}
}
class RfpPricingResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var int */
public int $RfpDocumentID=0,
/** @var PricedProposal|null */
public ?PricedProposal $Pricing=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['RfpDocumentID'])) $this->RfpDocumentID = $o['RfpDocumentID'];
if (isset($o['Pricing'])) $this->Pricing = JsonConverters::from('PricedProposal', $o['Pricing']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->RfpDocumentID)) $o['RfpDocumentID'] = $this->RfpDocumentID;
if (isset($this->Pricing)) $o['Pricing'] = JsonConverters::to('PricedProposal', $this->Pricing);
return empty($o) ? new class(){} : $o;
}
}
class RfpPricingRequest 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Rfp/{RfpDocumentUID}/Pricing HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RfpPricingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Pricing>
<Currency>String</Currency>
<EquipmentMargin>0</EquipmentMargin>
<EquipmentNotInCatalog>0</EquipmentNotInCatalog>
<MaterialsNotInCatalog>0</MaterialsNotInCatalog>
<PositionsNeedingRate>0</PositionsNeedingRate>
<PositionsNotInCatalog>0</PositionsNotInCatalog>
<ProjectName>String</ProjectName>
<RfpDocumentID>0</RfpDocumentID>
<Tasks>
<PricedTask>
<Category>String</Category>
<Equipment>
<PricedEquipment>
<BilledRate>0</BilledRate>
<CompanyCost>0</CompanyCost>
<Cost>0</Cost>
<CostRate>0</CostRate>
<DurationDays>0</DurationDays>
<EquipmentID>0</EquipmentID>
<EquipmentName>String</EquipmentName>
<HasRate>false</HasRate>
<IsInCatalog>false</IsInCatalog>
<Quantity>0</Quantity>
<RateType>String</RateType>
</PricedEquipment>
</Equipment>
<Materials>
<PricedMaterial>
<Cost>0</Cost>
<HasRate>false</HasRate>
<IsInCatalog>false</IsInCatalog>
<MaterialID>0</MaterialID>
<MaterialName>String</MaterialName>
<Quantity>0</Quantity>
<UnitCost>0</UnitCost>
</PricedMaterial>
</Materials>
<Name>String</Name>
<Positions>
<PricedPosition>
<ContactCount>0</ContactCount>
<Cost>
<Max>0</Max>
<Min>0</Min>
</Cost>
<HasInternalRate>false</HasInternalRate>
<Hours>0</Hours>
<MarketRateReference>0</MarketRateReference>
<PositionTag>String</PositionTag>
<RateAvg>0</RateAvg>
<RateMax>0</RateMax>
<RateMin>0</RateMin>
</PricedPosition>
</Positions>
<Subtotal>
<Max>0</Max>
<Min>0</Min>
</Subtotal>
</PricedTask>
</Tasks>
<Total>
<Max>0</Max>
<Min>0</Min>
</Total>
</Pricing>
<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>
<RfpDocumentID>0</RfpDocumentID>
</RfpPricingResponse>