| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Proposal |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedPosition:
position_tag: Optional[str] = None
hours: Optional[float] = None
crew_size: Optional[float] = None
utilization: Optional[float] = None
fixed_days: Optional[float] = None
headcount: Optional[int] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
contact_i_d: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedEquipment:
equipment_i_d: int = 0
equipment_name: Optional[str] = None
make_model: Optional[str] = None
quantity: Optional[float] = None
duration_days: Optional[float] = None
utilization: Optional[float] = None
fixed_days: Optional[float] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
suggested_equipment_i_d: int = 0
suggested_equipment_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedMaterial:
material_i_d: int = 0
material_name: Optional[str] = None
make_model: Optional[str] = None
quantity: Optional[float] = None
quantity_per_unit: Optional[float] = None
unit: Optional[str] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
suggested_material_i_d: int = 0
suggested_material_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskResourcing:
positions: List[ResourcedPosition] = field(default_factory=list)
equipment: List[ResourcedEquipment] = field(default_factory=list)
materials: List[ResourcedMaterial] = field(default_factory=list)
resourced_for_quantity: Optional[float] = None
production_rate_per_day: Optional[float] = None
fixed_days: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkPackageSpecRef:
section: Optional[str] = None
title: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskWorkPackage:
scope: Optional[str] = None
limits_of_work: Optional[str] = None
spec_refs: List[WorkPackageSpecRef] = field(default_factory=list)
constraints: List[str] = field(default_factory=list)
hold_points: List[str] = field(default_factory=list)
definition_of_done: List[str] = field(default_factory=list)
safety_note: Optional[str] = None
rfp_ref: Optional[str] = None
confidence: Optional[int] = None
spec_book: Optional[str] = None
user_scope: Optional[str] = None
dod_removed: List[int] = field(default_factory=list)
dod_extra: List[str] = field(default_factory=list)
user_edited: bool = False
dod_checked: List[str] = field(default_factory=list)
redraft_note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProposedTask:
seq: int = 0
name: Optional[str] = None
category: Optional[str] = None
quantity: Optional[float] = None
unit: Optional[str] = None
source_item_number: Optional[str] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
resourcing: Optional[TaskResourcing] = None
duration_days: Optional[float] = None
depends_on: List[int] = field(default_factory=list)
estimated_start_date: Optional[datetime.datetime] = None
estimated_end_date: Optional[datetime.datetime] = None
work_package: Optional[TaskWorkPackage] = None
created_job_i_d: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddendaChange:
change_id: Optional[str] = None
change_type: Optional[str] = None
target_seq: Optional[int] = None
item_number: Optional[str] = None
item_name: Optional[str] = None
field: Optional[str] = None
old_value: Optional[str] = None
new_value: Optional[str] = None
description: Optional[str] = None
status: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddendaChangeSet:
change_set_id: Optional[str] = None
source_rfp_document_i_d: int = 0
source_file_name: Optional[str] = None
document_type: Optional[str] = None
extracted_at_utc: Optional[datetime.datetime] = None
summary: Optional[str] = None
changes: List[AddendaChange] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WageClassification:
title: Optional[str] = None
base_rate: Optional[Decimal] = None
fringe_rate: Optional[Decimal] = None
parish_note: Optional[str] = None
source_line: Optional[str] = None
benchmark_fringe_rate: Optional[Decimal] = None
fringe_compare_note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WageDeterminationResult:
source_rfp_document_i_d: int = 0
source_file_name: Optional[str] = None
wd_number: Optional[str] = None
extracted_at_utc: Optional[datetime.datetime] = None
classifications: List[WageClassification] = field(default_factory=list)
source: Optional[str] = None
is_trustworthy: bool = False
executive_order_floor: Optional[Decimal] = None
published_date: Optional[str] = None
project_parish: Optional[str] = None
warnings: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectProposal:
rfp_document_i_d: int = 0
mode: Optional[str] = None
project_i_d: Optional[int] = None
change_order_i_d: Optional[int] = None
project_name: Optional[str] = None
client_name: Optional[str] = None
project_type: Optional[str] = None
project_location: Optional[str] = None
scope: Optional[str] = None
project_description: Optional[str] = None
contract_duration_days: Optional[int] = None
bid_due_date: Optional[str] = None
estimated_start_date: Optional[datetime.datetime] = None
estimated_end_date: Optional[datetime.datetime] = None
tasks: List[ProposedTask] = field(default_factory=list)
pending_addenda_diffs: List[AddendaChangeSet] = field(default_factory=list)
wage_determinations: List[WageDeterminationResult] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CrewPlanLine:
position_tag: Optional[str] = None
needed: int = 0
naive_total: int = 0
task_assignments: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpProposalResponse:
response_status: Optional[ResponseStatus] = None
rfp_document_i_d: int = 0
proposal: Optional[ProjectProposal] = None
crew_plan: List[CrewPlanLine] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpProposalRequest:
rfp_document_u_i_d: Optional[str] = None
Python RfpProposalRequest DTOs
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}/Proposal HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RfpProposalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CrewPlan>
<CrewPlanLine>
<NaiveTotal>0</NaiveTotal>
<Needed>0</Needed>
<PositionTag>String</PositionTag>
<TaskAssignments>0</TaskAssignments>
</CrewPlanLine>
</CrewPlan>
<Proposal>
<BidDueDate>String</BidDueDate>
<ChangeOrderID>0</ChangeOrderID>
<ClientName>String</ClientName>
<ContractDurationDays>0</ContractDurationDays>
<EstimatedEndDate>0001-01-01T00:00:00</EstimatedEndDate>
<EstimatedStartDate>0001-01-01T00:00:00</EstimatedStartDate>
<Mode>String</Mode>
<PendingAddendaDiffs>
<AddendaChangeSet>
<ChangeSetId>String</ChangeSetId>
<Changes>
<AddendaChange>
<ChangeId>String</ChangeId>
<ChangeType>String</ChangeType>
<Description>String</Description>
<Field>String</Field>
<ItemName>String</ItemName>
<ItemNumber>String</ItemNumber>
<NewValue>String</NewValue>
<OldValue>String</OldValue>
<Status>String</Status>
<TargetSeq>0</TargetSeq>
</AddendaChange>
</Changes>
<DocumentType>String</DocumentType>
<ExtractedAtUtc>0001-01-01T00:00:00</ExtractedAtUtc>
<SourceFileName>String</SourceFileName>
<SourceRfpDocumentID>0</SourceRfpDocumentID>
<Summary>String</Summary>
</AddendaChangeSet>
</PendingAddendaDiffs>
<ProjectDescription>String</ProjectDescription>
<ProjectID>0</ProjectID>
<ProjectLocation>String</ProjectLocation>
<ProjectName>String</ProjectName>
<ProjectType>String</ProjectType>
<RfpDocumentID>0</RfpDocumentID>
<Scope>String</Scope>
<Tasks>
<ProposedTask>
<Category>String</Category>
<CreatedJobID>0</CreatedJobID>
<DependsOn xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</DependsOn>
<DurationDays>0</DurationDays>
<EstimatedEndDate>0001-01-01T00:00:00</EstimatedEndDate>
<EstimatedStartDate>0001-01-01T00:00:00</EstimatedStartDate>
<Name>String</Name>
<Notes>String</Notes>
<Quantity>0</Quantity>
<Resourcing>
<Equipment>
<ResourcedEquipment>
<DurationDays>0</DurationDays>
<EquipmentID>0</EquipmentID>
<EquipmentName>String</EquipmentName>
<FixedDays>0</FixedDays>
<IsInCatalog>false</IsInCatalog>
<MakeModel>String</MakeModel>
<Notes>String</Notes>
<Quantity>0</Quantity>
<SourceReference>String</SourceReference>
<SuggestedEquipmentID>0</SuggestedEquipmentID>
<SuggestedEquipmentName>String</SuggestedEquipmentName>
<Utilization>0</Utilization>
</ResourcedEquipment>
</Equipment>
<FixedDays>0</FixedDays>
<Materials>
<ResourcedMaterial>
<IsInCatalog>false</IsInCatalog>
<MakeModel>String</MakeModel>
<MaterialID>0</MaterialID>
<MaterialName>String</MaterialName>
<Notes>String</Notes>
<Quantity>0</Quantity>
<QuantityPerUnit>0</QuantityPerUnit>
<SourceReference>String</SourceReference>
<SuggestedMaterialID>0</SuggestedMaterialID>
<SuggestedMaterialName>String</SuggestedMaterialName>
<Unit>String</Unit>
</ResourcedMaterial>
</Materials>
<Positions>
<ResourcedPosition>
<ContactID>0</ContactID>
<CrewSize>0</CrewSize>
<FixedDays>0</FixedDays>
<Headcount>0</Headcount>
<Hours>0</Hours>
<IsInCatalog>false</IsInCatalog>
<Notes>String</Notes>
<PositionTag>String</PositionTag>
<SourceReference>String</SourceReference>
<Utilization>0</Utilization>
</ResourcedPosition>
</Positions>
<ProductionRatePerDay>0</ProductionRatePerDay>
<ResourcedForQuantity>0</ResourcedForQuantity>
</Resourcing>
<Seq>0</Seq>
<SourceItemNumber>String</SourceItemNumber>
<SourceReference>String</SourceReference>
<Unit>String</Unit>
<WorkPackage>
<Confidence>0</Confidence>
<Constraints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</Constraints>
<DefinitionOfDone xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DefinitionOfDone>
<DodChecked xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DodChecked>
<DodExtra xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DodExtra>
<DodRemoved xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>0</d6p1:int>
</DodRemoved>
<HoldPoints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</HoldPoints>
<LimitsOfWork>String</LimitsOfWork>
<RedraftNote>String</RedraftNote>
<RfpRef>String</RfpRef>
<SafetyNote>String</SafetyNote>
<Scope>String</Scope>
<SpecBook>String</SpecBook>
<SpecRefs>
<WorkPackageSpecRef>
<Section>String</Section>
<Title>String</Title>
</WorkPackageSpecRef>
</SpecRefs>
<UserEdited>false</UserEdited>
<UserScope>String</UserScope>
</WorkPackage>
</ProposedTask>
</Tasks>
<WageDeterminations>
<WageDeterminationResult>
<Classifications>
<WageClassification>
<BaseRate>0</BaseRate>
<BenchmarkFringeRate>0</BenchmarkFringeRate>
<FringeCompareNote>String</FringeCompareNote>
<FringeRate>0</FringeRate>
<ParishNote>String</ParishNote>
<SourceLine>String</SourceLine>
<Title>String</Title>
</WageClassification>
</Classifications>
<ExecutiveOrderFloor>0</ExecutiveOrderFloor>
<ExtractedAtUtc>0001-01-01T00:00:00</ExtractedAtUtc>
<IsTrustworthy>false</IsTrustworthy>
<ProjectParish>String</ProjectParish>
<PublishedDate>String</PublishedDate>
<Source>String</Source>
<SourceFileName>String</SourceFileName>
<SourceRfpDocumentID>0</SourceRfpDocumentID>
<Warnings xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Warnings>
<WdNumber>String</WdNumber>
</WageDeterminationResult>
</WageDeterminations>
</Proposal>
<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>
</RfpProposalResponse>