Trendsic Platform Service

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RfpRefineRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Instruction>String</Instruction>
  <Layer>String</Layer>
  <Mode>String</Mode>
  <RfpDocumentUID>String</RfpDocumentUID>
</RfpRefineRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RfpRefineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Brief>
    <BidConstraints>
      <RfpBidConstraint>
        <Constraint>String</Constraint>
        <Detail>String</Detail>
      </RfpBidConstraint>
    </BidConstraints>
    <IssuingOrganization>String</IssuingOrganization>
    <LineItems>
      <RfpLineItem>
        <Category>String</Category>
        <Description>String</Description>
        <ItemNumber>String</ItemNumber>
        <Quantity>0</Quantity>
        <SourceReference>String</SourceReference>
        <Unit>String</Unit>
      </RfpLineItem>
    </LineItems>
    <Locations>
      <RfpLocation>
        <City>String</City>
        <Description>String</Description>
        <Identifier>String</Identifier>
        <State>String</State>
      </RfpLocation>
    </Locations>
    <ProjectTitle>String</ProjectTitle>
    <ProjectType>String</ProjectType>
    <Schedule>
      <BidDueDate>String</BidDueDate>
      <ContractDurationDays>0</ContractDurationDays>
      <EstimatedStartDate>String</EstimatedStartDate>
      <Notes>String</Notes>
      <QuestionsDueDate>String</QuestionsDueDate>
    </Schedule>
    <SolicitationNumber>String</SolicitationNumber>
    <SpecialRequirements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </SpecialRequirements>
    <Summary>String</Summary>
  </Brief>
  <CacheCreationTokens>0</CacheCreationTokens>
  <CacheReadTokens>0</CacheReadTokens>
  <CrewPlan>
    <CrewPlanLine>
      <NaiveTotal>0</NaiveTotal>
      <Needed>0</Needed>
      <PositionTag>String</PositionTag>
      <TaskAssignments>0</TaskAssignments>
    </CrewPlanLine>
  </CrewPlan>
  <InputTokens>0</InputTokens>
  <Layer>String</Layer>
  <Mode>String</Mode>
  <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>
  <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>
    <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>
        <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>
              <IsInCatalog>false</IsInCatalog>
              <MakeModel>String</MakeModel>
              <Notes>String</Notes>
              <Quantity>0</Quantity>
              <SourceReference>String</SourceReference>
              <SuggestedEquipmentID>0</SuggestedEquipmentID>
              <SuggestedEquipmentName>String</SuggestedEquipmentName>
            </ResourcedEquipment>
          </Equipment>
          <Materials>
            <ResourcedMaterial>
              <IsInCatalog>false</IsInCatalog>
              <MakeModel>String</MakeModel>
              <MaterialID>0</MaterialID>
              <MaterialName>String</MaterialName>
              <Notes>String</Notes>
              <Quantity>0</Quantity>
              <SourceReference>String</SourceReference>
              <SuggestedMaterialID>0</SuggestedMaterialID>
              <SuggestedMaterialName>String</SuggestedMaterialName>
              <Unit>String</Unit>
            </ResourcedMaterial>
          </Materials>
          <Positions>
            <ResourcedPosition>
              <ContactID>0</ContactID>
              <Headcount>0</Headcount>
              <Hours>0</Hours>
              <IsInCatalog>false</IsInCatalog>
              <Notes>String</Notes>
              <PositionTag>String</PositionTag>
              <SourceReference>String</SourceReference>
            </ResourcedPosition>
          </Positions>
        </Resourcing>
        <Seq>0</Seq>
        <SourceItemNumber>String</SourceItemNumber>
        <SourceReference>String</SourceReference>
        <Unit>String</Unit>
      </ProposedTask>
    </Tasks>
  </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>
  <TurnCount>0</TurnCount>
</RfpRefineResponse>