Trendsic Platform Service

<back to all web services

RfpRefineRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/Refine
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 RfpLocation:
    description: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    identifier: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpSchedule:
    bid_due_date: Optional[str] = None
    estimated_start_date: Optional[str] = None
    questions_due_date: Optional[str] = None
    contract_duration_days: Optional[int] = None
    notes: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpLineItem:
    item_number: Optional[str] = None
    description: Optional[str] = None
    quantity: Optional[float] = None
    unit: Optional[str] = None
    category: Optional[str] = None
    source_reference: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpBidConstraint:
    constraint: Optional[str] = None
    detail: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpBrief:
    project_title: Optional[str] = None
    solicitation_number: Optional[str] = None
    issuing_organization: Optional[str] = None
    project_type: Optional[str] = None
    summary: Optional[str] = None
    locations: List[RfpLocation] = field(default_factory=list)
    schedule: Optional[RfpSchedule] = None
    line_items: List[RfpLineItem] = field(default_factory=list)
    bid_constraints: List[RfpBidConstraint] = field(default_factory=list)
    special_requirements: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedPosition:
    position_tag: Optional[str] = None
    hours: 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
    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
    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)


@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


@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)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CostRange:
    min: float = 0.0
    max: float = 0.0
    mid: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PricedPosition:
    position_tag: Optional[str] = None
    hours: float = 0.0
    has_internal_rate: bool = False
    rate_min: Optional[float] = None
    rate_max: Optional[float] = None
    rate_avg: Optional[float] = None
    contact_count: int = 0
    cost: Optional[CostRange] = None
    market_rate_reference: Optional[float] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PricedEquipment:
    equipment_i_d: int = 0
    equipment_name: Optional[str] = None
    quantity: float = 0.0
    duration_days: Optional[float] = None
    rate_type: Optional[str] = None
    billed_rate: Optional[float] = None
    cost_rate: Optional[float] = None
    has_rate: bool = False
    is_in_catalog: bool = False
    cost: float = 0.0
    company_cost: float = 0.0
    margin: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PricedMaterial:
    material_i_d: int = 0
    material_name: Optional[str] = None
    quantity: float = 0.0
    unit_cost: Optional[float] = None
    has_rate: bool = False
    is_in_catalog: bool = False
    cost: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PricedTask:
    name: Optional[str] = None
    category: Optional[str] = None
    positions: List[PricedPosition] = field(default_factory=list)
    equipment: List[PricedEquipment] = field(default_factory=list)
    materials: List[PricedMaterial] = field(default_factory=list)
    subtotal: Optional[CostRange] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PricedProposal:
    rfp_document_i_d: int = 0
    project_name: Optional[str] = None
    currency: Optional[str] = None
    tasks: List[PricedTask] = field(default_factory=list)
    total: Optional[CostRange] = None
    positions_needing_rate: int = 0
    equipment_not_in_catalog: int = 0
    materials_not_in_catalog: int = 0
    positions_not_in_catalog: int = 0
    equipment_margin: float = 0.0


@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 RfpRefineResponse:
    response_status: Optional[ResponseStatus] = None
    rfp_document_i_d: int = 0
    layer: Optional[str] = None
    mode: Optional[str] = None
    turn_count: int = 0
    brief: Optional[RfpBrief] = None
    proposal: Optional[ProjectProposal] = None
    pricing: Optional[PricedProposal] = None
    crew_plan: List[CrewPlanLine] = field(default_factory=list)
    cache_read_tokens: int = 0
    cache_creation_tokens: int = 0
    input_tokens: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpRefineRequest:
    rfp_document_u_i_d: Optional[str] = None
    layer: Optional[str] = None
    mode: Optional[str] = None
    instruction: Optional[str] = None

Python RfpRefineRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Rfp/{RfpDocumentUID}/Refine HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RfpDocumentUID":"String","Layer":"String","Mode":"String","Instruction":"String"}

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"}},"RfpDocumentID":0,"Layer":"String","Mode":"String","TurnCount":0,"Brief":{"ProjectTitle":"String","SolicitationNumber":"String","IssuingOrganization":"String","ProjectType":"String","Summary":"String","Locations":[{"Description":"String","City":"String","State":"String","Identifier":"String"}],"Schedule":{"BidDueDate":"String","EstimatedStartDate":"String","QuestionsDueDate":"String","ContractDurationDays":0,"Notes":"String"},"LineItems":[{"ItemNumber":"String","Description":"String","Quantity":0,"Unit":"String","Category":"String","SourceReference":"String"}],"BidConstraints":[{"Constraint":"String","Detail":"String"}],"SpecialRequirements":["String"]},"Proposal":{"RfpDocumentID":0,"Mode":"String","ProjectID":0,"ChangeOrderID":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"}]},"Pricing":{"RfpDocumentID":0,"ProjectName":"String","Currency":"String","Tasks":[{"Name":"String","Category":"String","Positions":[{"PositionTag":"String","Hours":0,"HasInternalRate":false,"RateMin":0,"RateMax":0,"RateAvg":0,"ContactCount":0,"Cost":{"Min":0,"Max":0,"Mid":0},"MarketRateReference":0}],"Equipment":[{"EquipmentID":0,"EquipmentName":"String","Quantity":0,"DurationDays":0,"RateType":"String","BilledRate":0,"CostRate":0,"HasRate":false,"IsInCatalog":false,"Cost":0,"CompanyCost":0,"Margin":0}],"Materials":[{"MaterialID":0,"MaterialName":"String","Quantity":0,"UnitCost":0,"HasRate":false,"IsInCatalog":false,"Cost":0}],"Subtotal":{"Min":0,"Max":0,"Mid":0}}],"Total":{"Min":0,"Max":0,"Mid":0},"PositionsNeedingRate":0,"EquipmentNotInCatalog":0,"MaterialsNotInCatalog":0,"PositionsNotInCatalog":0,"EquipmentMargin":0},"CrewPlan":[{"PositionTag":"String","Needed":0,"NaiveTotal":0,"TaskAssignments":0}],"CacheReadTokens":0,"CacheCreationTokens":0,"InputTokens":0}