| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Proposal |
|---|
<?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 ResourcedPosition implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PositionTag=null,
/** @var float|null */
public ?float $Hours=null,
/** @var int|null */
public ?int $Headcount=null,
/** @var string|null */
public ?string $SourceReference=null,
/** @var string|null */
public ?string $Notes=null,
/** @var bool|null */
public ?bool $IsInCatalog=null,
/** @var int|null */
public ?int $ContactID=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['Headcount'])) $this->Headcount = $o['Headcount'];
if (isset($o['SourceReference'])) $this->SourceReference = $o['SourceReference'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['IsInCatalog'])) $this->IsInCatalog = $o['IsInCatalog'];
if (isset($o['ContactID'])) $this->ContactID = $o['ContactID'];
}
/** @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->Headcount)) $o['Headcount'] = $this->Headcount;
if (isset($this->SourceReference)) $o['SourceReference'] = $this->SourceReference;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->IsInCatalog)) $o['IsInCatalog'] = $this->IsInCatalog;
if (isset($this->ContactID)) $o['ContactID'] = $this->ContactID;
return empty($o) ? new class(){} : $o;
}
}
class ResourcedEquipment implements JsonSerializable
{
public function __construct(
/** @var int */
public int $EquipmentID=0,
/** @var string|null */
public ?string $EquipmentName=null,
/** @var string|null */
public ?string $MakeModel=null,
/** @var float|null */
public ?float $Quantity=null,
/** @var float|null */
public ?float $DurationDays=null,
/** @var string|null */
public ?string $SourceReference=null,
/** @var string|null */
public ?string $Notes=null,
/** @var bool|null */
public ?bool $IsInCatalog=null,
/** @var int */
public int $SuggestedEquipmentID=0,
/** @var string|null */
public ?string $SuggestedEquipmentName=null
) {
}
/** @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['MakeModel'])) $this->MakeModel = $o['MakeModel'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['DurationDays'])) $this->DurationDays = $o['DurationDays'];
if (isset($o['SourceReference'])) $this->SourceReference = $o['SourceReference'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['IsInCatalog'])) $this->IsInCatalog = $o['IsInCatalog'];
if (isset($o['SuggestedEquipmentID'])) $this->SuggestedEquipmentID = $o['SuggestedEquipmentID'];
if (isset($o['SuggestedEquipmentName'])) $this->SuggestedEquipmentName = $o['SuggestedEquipmentName'];
}
/** @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->MakeModel)) $o['MakeModel'] = $this->MakeModel;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->DurationDays)) $o['DurationDays'] = $this->DurationDays;
if (isset($this->SourceReference)) $o['SourceReference'] = $this->SourceReference;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->IsInCatalog)) $o['IsInCatalog'] = $this->IsInCatalog;
if (isset($this->SuggestedEquipmentID)) $o['SuggestedEquipmentID'] = $this->SuggestedEquipmentID;
if (isset($this->SuggestedEquipmentName)) $o['SuggestedEquipmentName'] = $this->SuggestedEquipmentName;
return empty($o) ? new class(){} : $o;
}
}
class ResourcedMaterial implements JsonSerializable
{
public function __construct(
/** @var int */
public int $MaterialID=0,
/** @var string|null */
public ?string $MaterialName=null,
/** @var string|null */
public ?string $MakeModel=null,
/** @var float|null */
public ?float $Quantity=null,
/** @var string|null */
public ?string $Unit=null,
/** @var string|null */
public ?string $SourceReference=null,
/** @var string|null */
public ?string $Notes=null,
/** @var bool|null */
public ?bool $IsInCatalog=null,
/** @var int */
public int $SuggestedMaterialID=0,
/** @var string|null */
public ?string $SuggestedMaterialName=null
) {
}
/** @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['MakeModel'])) $this->MakeModel = $o['MakeModel'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['SourceReference'])) $this->SourceReference = $o['SourceReference'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['IsInCatalog'])) $this->IsInCatalog = $o['IsInCatalog'];
if (isset($o['SuggestedMaterialID'])) $this->SuggestedMaterialID = $o['SuggestedMaterialID'];
if (isset($o['SuggestedMaterialName'])) $this->SuggestedMaterialName = $o['SuggestedMaterialName'];
}
/** @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->MakeModel)) $o['MakeModel'] = $this->MakeModel;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->SourceReference)) $o['SourceReference'] = $this->SourceReference;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->IsInCatalog)) $o['IsInCatalog'] = $this->IsInCatalog;
if (isset($this->SuggestedMaterialID)) $o['SuggestedMaterialID'] = $this->SuggestedMaterialID;
if (isset($this->SuggestedMaterialName)) $o['SuggestedMaterialName'] = $this->SuggestedMaterialName;
return empty($o) ? new class(){} : $o;
}
}
class TaskResourcing implements JsonSerializable
{
public function __construct(
/** @var array<ResourcedPosition>|null */
public ?array $Positions=null,
/** @var array<ResourcedEquipment>|null */
public ?array $Equipment=null,
/** @var array<ResourcedMaterial>|null */
public ?array $Materials=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Positions'])) $this->Positions = JsonConverters::fromArray('ResourcedPosition', $o['Positions']);
if (isset($o['Equipment'])) $this->Equipment = JsonConverters::fromArray('ResourcedEquipment', $o['Equipment']);
if (isset($o['Materials'])) $this->Materials = JsonConverters::fromArray('ResourcedMaterial', $o['Materials']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Positions)) $o['Positions'] = JsonConverters::toArray('ResourcedPosition', $this->Positions);
if (isset($this->Equipment)) $o['Equipment'] = JsonConverters::toArray('ResourcedEquipment', $this->Equipment);
if (isset($this->Materials)) $o['Materials'] = JsonConverters::toArray('ResourcedMaterial', $this->Materials);
return empty($o) ? new class(){} : $o;
}
}
class ProposedTask implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Seq=0,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Category=null,
/** @var float|null */
public ?float $Quantity=null,
/** @var string|null */
public ?string $Unit=null,
/** @var string|null */
public ?string $SourceItemNumber=null,
/** @var string|null */
public ?string $SourceReference=null,
/** @var string|null */
public ?string $Notes=null,
/** @var TaskResourcing|null */
public ?TaskResourcing $Resourcing=null,
/** @var float|null */
public ?float $DurationDays=null,
/** @var array<int>|null */
public ?array $DependsOn=null,
/** @var DateTime|null */
public ?DateTime $EstimatedStartDate=null,
/** @var DateTime|null */
public ?DateTime $EstimatedEndDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Seq'])) $this->Seq = $o['Seq'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Category'])) $this->Category = $o['Category'];
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['SourceItemNumber'])) $this->SourceItemNumber = $o['SourceItemNumber'];
if (isset($o['SourceReference'])) $this->SourceReference = $o['SourceReference'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Resourcing'])) $this->Resourcing = JsonConverters::from('TaskResourcing', $o['Resourcing']);
if (isset($o['DurationDays'])) $this->DurationDays = $o['DurationDays'];
if (isset($o['DependsOn'])) $this->DependsOn = JsonConverters::fromArray('int', $o['DependsOn']);
if (isset($o['EstimatedStartDate'])) $this->EstimatedStartDate = JsonConverters::from('DateTime', $o['EstimatedStartDate']);
if (isset($o['EstimatedEndDate'])) $this->EstimatedEndDate = JsonConverters::from('DateTime', $o['EstimatedEndDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Seq)) $o['Seq'] = $this->Seq;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Category)) $o['Category'] = $this->Category;
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->SourceItemNumber)) $o['SourceItemNumber'] = $this->SourceItemNumber;
if (isset($this->SourceReference)) $o['SourceReference'] = $this->SourceReference;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Resourcing)) $o['Resourcing'] = JsonConverters::to('TaskResourcing', $this->Resourcing);
if (isset($this->DurationDays)) $o['DurationDays'] = $this->DurationDays;
if (isset($this->DependsOn)) $o['DependsOn'] = JsonConverters::toArray('int', $this->DependsOn);
if (isset($this->EstimatedStartDate)) $o['EstimatedStartDate'] = JsonConverters::to('DateTime', $this->EstimatedStartDate);
if (isset($this->EstimatedEndDate)) $o['EstimatedEndDate'] = JsonConverters::to('DateTime', $this->EstimatedEndDate);
return empty($o) ? new class(){} : $o;
}
}
class ProjectProposal implements JsonSerializable
{
public function __construct(
/** @var int */
public int $RfpDocumentID=0,
/** @var string|null */
public ?string $ProjectName=null,
/** @var string|null */
public ?string $ClientName=null,
/** @var string|null */
public ?string $ProjectType=null,
/** @var string|null */
public ?string $ProjectLocation=null,
/** @var string|null */
public ?string $Scope=null,
/** @var string|null */
public ?string $ProjectDescription=null,
/** @var int|null */
public ?int $ContractDurationDays=null,
/** @var string|null */
public ?string $BidDueDate=null,
/** @var DateTime|null */
public ?DateTime $EstimatedStartDate=null,
/** @var DateTime|null */
public ?DateTime $EstimatedEndDate=null,
/** @var array<ProposedTask>|null */
public ?array $Tasks=null
) {
}
/** @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['ClientName'])) $this->ClientName = $o['ClientName'];
if (isset($o['ProjectType'])) $this->ProjectType = $o['ProjectType'];
if (isset($o['ProjectLocation'])) $this->ProjectLocation = $o['ProjectLocation'];
if (isset($o['Scope'])) $this->Scope = $o['Scope'];
if (isset($o['ProjectDescription'])) $this->ProjectDescription = $o['ProjectDescription'];
if (isset($o['ContractDurationDays'])) $this->ContractDurationDays = $o['ContractDurationDays'];
if (isset($o['BidDueDate'])) $this->BidDueDate = $o['BidDueDate'];
if (isset($o['EstimatedStartDate'])) $this->EstimatedStartDate = JsonConverters::from('DateTime', $o['EstimatedStartDate']);
if (isset($o['EstimatedEndDate'])) $this->EstimatedEndDate = JsonConverters::from('DateTime', $o['EstimatedEndDate']);
if (isset($o['Tasks'])) $this->Tasks = JsonConverters::fromArray('ProposedTask', $o['Tasks']);
}
/** @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->ClientName)) $o['ClientName'] = $this->ClientName;
if (isset($this->ProjectType)) $o['ProjectType'] = $this->ProjectType;
if (isset($this->ProjectLocation)) $o['ProjectLocation'] = $this->ProjectLocation;
if (isset($this->Scope)) $o['Scope'] = $this->Scope;
if (isset($this->ProjectDescription)) $o['ProjectDescription'] = $this->ProjectDescription;
if (isset($this->ContractDurationDays)) $o['ContractDurationDays'] = $this->ContractDurationDays;
if (isset($this->BidDueDate)) $o['BidDueDate'] = $this->BidDueDate;
if (isset($this->EstimatedStartDate)) $o['EstimatedStartDate'] = JsonConverters::to('DateTime', $this->EstimatedStartDate);
if (isset($this->EstimatedEndDate)) $o['EstimatedEndDate'] = JsonConverters::to('DateTime', $this->EstimatedEndDate);
if (isset($this->Tasks)) $o['Tasks'] = JsonConverters::toArray('ProposedTask', $this->Tasks);
return empty($o) ? new class(){} : $o;
}
}
class CrewPlanLine implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PositionTag=null,
/** @var int */
public int $Needed=0,
/** @var int */
public int $NaiveTotal=0,
/** @var int */
public int $TaskAssignments=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PositionTag'])) $this->PositionTag = $o['PositionTag'];
if (isset($o['Needed'])) $this->Needed = $o['Needed'];
if (isset($o['NaiveTotal'])) $this->NaiveTotal = $o['NaiveTotal'];
if (isset($o['TaskAssignments'])) $this->TaskAssignments = $o['TaskAssignments'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PositionTag)) $o['PositionTag'] = $this->PositionTag;
if (isset($this->Needed)) $o['Needed'] = $this->Needed;
if (isset($this->NaiveTotal)) $o['NaiveTotal'] = $this->NaiveTotal;
if (isset($this->TaskAssignments)) $o['TaskAssignments'] = $this->TaskAssignments;
return empty($o) ? new class(){} : $o;
}
}
class RfpProposalResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var int */
public int $RfpDocumentID=0,
/** @var ProjectProposal|null */
public ?ProjectProposal $Proposal=null,
/** @var array<CrewPlanLine>|null */
public ?array $CrewPlan=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['Proposal'])) $this->Proposal = JsonConverters::from('ProjectProposal', $o['Proposal']);
if (isset($o['CrewPlan'])) $this->CrewPlan = JsonConverters::fromArray('CrewPlanLine', $o['CrewPlan']);
}
/** @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->Proposal)) $o['Proposal'] = JsonConverters::to('ProjectProposal', $this->Proposal);
if (isset($this->CrewPlan)) $o['CrewPlan'] = JsonConverters::toArray('CrewPlanLine', $this->CrewPlan);
return empty($o) ? new class(){} : $o;
}
}
class RfpProposalRequest 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Rfp/{RfpDocumentUID}/Proposal 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"}},"RfpDocumentID":0,"Proposal":{"RfpDocumentID":0,"ProjectName":"String","ClientName":"String","ProjectType":"String","ProjectLocation":"String","Scope":"String","ProjectDescription":"String","ContractDurationDays":0,"BidDueDate":"String","EstimatedStartDate":"0001-01-01T00:00:00.0000000","EstimatedEndDate":"0001-01-01T00:00:00.0000000","Tasks":[{"Seq":0,"Name":"String","Category":"String","Quantity":0,"Unit":"String","SourceItemNumber":"String","SourceReference":"String","Notes":"String","Resourcing":{"Positions":[{"PositionTag":"String","Hours":0,"Headcount":0,"SourceReference":"String","Notes":"String","IsInCatalog":false,"ContactID":0}],"Equipment":[{"EquipmentID":0,"EquipmentName":"String","MakeModel":"String","Quantity":0,"DurationDays":0,"SourceReference":"String","Notes":"String","IsInCatalog":false,"SuggestedEquipmentID":0,"SuggestedEquipmentName":"String"}],"Materials":[{"MaterialID":0,"MaterialName":"String","MakeModel":"String","Quantity":0,"Unit":"String","SourceReference":"String","Notes":"String","IsInCatalog":false,"SuggestedMaterialID":0,"SuggestedMaterialName":"String"}]},"DurationDays":0,"DependsOn":[0],"EstimatedStartDate":"0001-01-01T00:00:00.0000000","EstimatedEndDate":"0001-01-01T00:00:00.0000000"}]},"CrewPlan":[{"PositionTag":"String","Needed":0,"NaiveTotal":0,"TaskAssignments":0}]}