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 Foundation
import ServiceStack

public class RfpRefineRequest : Codable
{
    public var rfpDocumentUID:String
    public var layer:String
    public var mode:String
    public var instruction:String

    required public init(){}
}

public class RfpRefineResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rfpDocumentID:Int
    public var layer:String
    public var mode:String
    public var turnCount:Int
    public var brief:RfpBrief
    public var proposal:ProjectProposal
    public var pricing:PricedProposal
    public var crewPlan:[CrewPlanLine] = []
    public var cacheReadTokens:Int
    public var cacheCreationTokens:Int
    public var inputTokens:Int

    required public init(){}
}

public class RfpBrief : Codable
{
    public var projectTitle:String
    public var solicitationNumber:String
    public var issuingOrganization:String
    public var projectType:String
    public var summary:String
    public var locations:[RfpLocation] = []
    public var schedule:RfpSchedule
    public var lineItems:[RfpLineItem] = []
    public var bidConstraints:[RfpBidConstraint] = []
    public var specialRequirements:[String] = []

    required public init(){}
}

public class RfpLocation : Codable
{
    public var Description:String
    public var city:String
    public var state:String
    public var identifier:String

    required public init(){}
}

public class RfpSchedule : Codable
{
    public var bidDueDate:String
    public var estimatedStartDate:String
    public var questionsDueDate:String
    public var contractDurationDays:Int?
    public var notes:String

    required public init(){}
}

public class RfpLineItem : Codable
{
    public var itemNumber:String
    public var Description:String
    public var quantity:Double?
    public var unit:String
    public var category:String
    public var sourceReference:String

    required public init(){}
}

public class RfpBidConstraint : Codable
{
    public var constraint:String
    public var detail:String

    required public init(){}
}

public class ProjectProposal : Codable
{
    public var rfpDocumentID:Int
    public var mode:String
    public var projectID:Int?
    public var changeOrderID:Int?
    public var projectName:String
    public var clientName:String
    public var projectType:String
    public var projectLocation:String
    public var scope:String
    public var projectDescription:String
    public var contractDurationDays:Int?
    public var bidDueDate:String
    public var estimatedStartDate:Date?
    public var estimatedEndDate:Date?
    public var tasks:[ProposedTask] = []

    required public init(){}
}

public class ProposedTask : Codable
{
    public var seq:Int
    public var name:String
    public var category:String
    public var quantity:Double?
    public var unit:String
    public var sourceItemNumber:String
    public var sourceReference:String
    public var notes:String
    public var resourcing:TaskResourcing
    public var durationDays:Double?
    public var dependsOn:[Int] = []
    public var estimatedStartDate:Date?
    public var estimatedEndDate:Date?

    required public init(){}
}

public class TaskResourcing : Codable
{
    public var positions:[ResourcedPosition] = []
    public var equipment:[ResourcedEquipment] = []
    public var materials:[ResourcedMaterial] = []

    required public init(){}
}

public class ResourcedPosition : Codable
{
    public var positionTag:String
    public var hours:Double?
    public var headcount:Int?
    public var sourceReference:String
    public var notes:String
    public var isInCatalog:Bool
    public var contactID:Int?

    required public init(){}
}

public class ResourcedEquipment : Codable
{
    public var equipmentID:Int
    public var equipmentName:String
    public var makeModel:String
    public var quantity:Double?
    public var durationDays:Double?
    public var sourceReference:String
    public var notes:String
    public var isInCatalog:Bool
    public var suggestedEquipmentID:Int
    public var suggestedEquipmentName:String

    required public init(){}
}

public class ResourcedMaterial : Codable
{
    public var materialID:Int
    public var materialName:String
    public var makeModel:String
    public var quantity:Double?
    public var unit:String
    public var sourceReference:String
    public var notes:String
    public var isInCatalog:Bool
    public var suggestedMaterialID:Int
    public var suggestedMaterialName:String

    required public init(){}
}

public class PricedProposal : Codable
{
    public var rfpDocumentID:Int
    public var projectName:String
    public var currency:String
    public var tasks:[PricedTask] = []
    public var total:CostRange
    public var positionsNeedingRate:Int
    public var equipmentNotInCatalog:Int
    public var materialsNotInCatalog:Int
    public var positionsNotInCatalog:Int
    public var equipmentMargin:Double

    required public init(){}
}

public class PricedTask : Codable
{
    public var name:String
    public var category:String
    public var positions:[PricedPosition] = []
    public var equipment:[PricedEquipment] = []
    public var materials:[PricedMaterial] = []
    public var subtotal:CostRange

    required public init(){}
}

public class PricedPosition : Codable
{
    public var positionTag:String
    public var hours:Double
    public var hasInternalRate:Bool
    public var rateMin:Double?
    public var rateMax:Double?
    public var rateAvg:Double?
    public var contactCount:Int
    public var cost:CostRange
    public var marketRateReference:Double?

    required public init(){}
}

public class CostRange : Codable
{
    public var min:Double
    public var max:Double
    public var mid:Double

    required public init(){}
}

public class PricedEquipment : Codable
{
    public var equipmentID:Int
    public var equipmentName:String
    public var quantity:Double
    public var durationDays:Double?
    public var rateType:String
    public var billedRate:Double?
    public var costRate:Double?
    public var hasRate:Bool
    public var isInCatalog:Bool
    public var cost:Double
    public var companyCost:Double
    public var margin:Double

    required public init(){}
}

public class PricedMaterial : Codable
{
    public var materialID:Int
    public var materialName:String
    public var quantity:Double
    public var unitCost:Double?
    public var hasRate:Bool
    public var isInCatalog:Bool
    public var cost:Double

    required public init(){}
}

public class CrewPlanLine : Codable
{
    public var positionTag:String
    public var needed:Int
    public var naiveTotal:Int
    public var taskAssignments:Int

    required public init(){}
}

Swift 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>