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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class RfpRefineRequest
{
    open var RfpDocumentUID:String? = null
    open var Layer:String? = null
    open var Mode:String? = null
    open var Instruction:String? = null
}

open class RfpRefineResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var RfpDocumentID:Int? = null
    open var Layer:String? = null
    open var Mode:String? = null
    open var TurnCount:Int? = null
    open var Brief:RfpBrief? = null
    open var Proposal:ProjectProposal? = null
    open var Pricing:PricedProposal? = null
    open var CrewPlan:ArrayList<CrewPlanLine> = ArrayList<CrewPlanLine>()
    open var CacheReadTokens:Long? = null
    open var CacheCreationTokens:Long? = null
    open var InputTokens:Long? = null
}

open class RfpBrief
{
    open var ProjectTitle:String? = null
    open var SolicitationNumber:String? = null
    open var IssuingOrganization:String? = null
    open var ProjectType:String? = null
    open var Summary:String? = null
    open var Locations:ArrayList<RfpLocation> = ArrayList<RfpLocation>()
    open var Schedule:RfpSchedule? = null
    open var LineItems:ArrayList<RfpLineItem> = ArrayList<RfpLineItem>()
    open var BidConstraints:ArrayList<RfpBidConstraint> = ArrayList<RfpBidConstraint>()
    open var SpecialRequirements:ArrayList<String> = ArrayList<String>()
}

open class RfpLocation
{
    open var Description:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Identifier:String? = null
}

open class RfpSchedule
{
    open var BidDueDate:String? = null
    open var EstimatedStartDate:String? = null
    open var QuestionsDueDate:String? = null
    open var ContractDurationDays:Int? = null
    open var Notes:String? = null
}

open class RfpLineItem
{
    open var ItemNumber:String? = null
    open var Description:String? = null
    open var Quantity:Double? = null
    open var Unit:String? = null
    open var Category:String? = null
    open var SourceReference:String? = null
}

open class RfpBidConstraint
{
    open var Constraint:String? = null
    open var Detail:String? = null
}

open class ProjectProposal
{
    open var RfpDocumentID:Int? = null
    open var Mode:String? = null
    open var ProjectID:Int? = null
    open var ChangeOrderID:Int? = null
    open var ProjectName:String? = null
    open var ClientName:String? = null
    open var ProjectType:String? = null
    open var ProjectLocation:String? = null
    open var Scope:String? = null
    open var ProjectDescription:String? = null
    open var ContractDurationDays:Int? = null
    open var BidDueDate:String? = null
    open var EstimatedStartDate:Date? = null
    open var EstimatedEndDate:Date? = null
    open var Tasks:ArrayList<ProposedTask> = ArrayList<ProposedTask>()
}

open class ProposedTask
{
    open var Seq:Int? = null
    open var Name:String? = null
    open var Category:String? = null
    open var Quantity:Double? = null
    open var Unit:String? = null
    open var SourceItemNumber:String? = null
    open var SourceReference:String? = null
    open var Notes:String? = null
    open var Resourcing:TaskResourcing? = null
    open var DurationDays:Double? = null
    open var DependsOn:ArrayList<Int> = ArrayList<Int>()
    open var EstimatedStartDate:Date? = null
    open var EstimatedEndDate:Date? = null
}

open class TaskResourcing
{
    open var Positions:ArrayList<ResourcedPosition> = ArrayList<ResourcedPosition>()
    open var Equipment:ArrayList<ResourcedEquipment> = ArrayList<ResourcedEquipment>()
    open var Materials:ArrayList<ResourcedMaterial> = ArrayList<ResourcedMaterial>()
}

open class ResourcedPosition
{
    open var PositionTag:String? = null
    open var Hours:Double? = null
    open var Headcount:Int? = null
    open var SourceReference:String? = null
    open var Notes:String? = null
    open var IsInCatalog:Boolean? = null
    open var ContactID:Int? = null
}

open class ResourcedEquipment
{
    open var EquipmentID:Int? = null
    open var EquipmentName:String? = null
    open var MakeModel:String? = null
    open var Quantity:Double? = null
    open var DurationDays:Double? = null
    open var SourceReference:String? = null
    open var Notes:String? = null
    open var IsInCatalog:Boolean? = null
    open var SuggestedEquipmentID:Int? = null
    open var SuggestedEquipmentName:String? = null
}

open class ResourcedMaterial
{
    open var MaterialID:Int? = null
    open var MaterialName:String? = null
    open var MakeModel:String? = null
    open var Quantity:Double? = null
    open var Unit:String? = null
    open var SourceReference:String? = null
    open var Notes:String? = null
    open var IsInCatalog:Boolean? = null
    open var SuggestedMaterialID:Int? = null
    open var SuggestedMaterialName:String? = null
}

open class PricedProposal
{
    open var RfpDocumentID:Int? = null
    open var ProjectName:String? = null
    open var Currency:String? = null
    open var Tasks:ArrayList<PricedTask> = ArrayList<PricedTask>()
    open var Total:CostRange? = null
    open var PositionsNeedingRate:Int? = null
    open var EquipmentNotInCatalog:Int? = null
    open var MaterialsNotInCatalog:Int? = null
    open var PositionsNotInCatalog:Int? = null
    open var EquipmentMargin:Double? = null
}

open class PricedTask
{
    open var Name:String? = null
    open var Category:String? = null
    open var Positions:ArrayList<PricedPosition> = ArrayList<PricedPosition>()
    open var Equipment:ArrayList<PricedEquipment> = ArrayList<PricedEquipment>()
    open var Materials:ArrayList<PricedMaterial> = ArrayList<PricedMaterial>()
    open var Subtotal:CostRange? = null
}

open class PricedPosition
{
    open var PositionTag:String? = null
    open var Hours:Double? = null
    open var HasInternalRate:Boolean? = null
    open var RateMin:Double? = null
    open var RateMax:Double? = null
    open var RateAvg:Double? = null
    open var ContactCount:Int? = null
    open var Cost:CostRange? = null
    open var MarketRateReference:Double? = null
}

open class CostRange
{
    open var Min:Double? = null
    open var Max:Double? = null
    open var Mid:Double? = null
}

open class PricedEquipment
{
    open var EquipmentID:Int? = null
    open var EquipmentName:String? = null
    open var Quantity:Double? = null
    open var DurationDays:Double? = null
    open var RateType:String? = null
    open var BilledRate:Double? = null
    open var CostRate:Double? = null
    open var HasRate:Boolean? = null
    open var IsInCatalog:Boolean? = null
    open var Cost:Double? = null
    open var CompanyCost:Double? = null
    open var Margin:Double? = null
}

open class PricedMaterial
{
    open var MaterialID:Int? = null
    open var MaterialName:String? = null
    open var Quantity:Double? = null
    open var UnitCost:Double? = null
    open var HasRate:Boolean? = null
    open var IsInCatalog:Boolean? = null
    open var Cost:Double? = null
}

open class CrewPlanLine
{
    open var PositionTag:String? = null
    open var Needed:Int? = null
    open var NaiveTotal:Int? = null
    open var TaskAssignments:Int? = null
}

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