| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Estimate/Jobs/{TaskSeq}/assembly |
|---|
import Foundation
import ServiceStack
public class ApplyAssemblyRequest : Codable
{
public var rfpDocumentUID:String
public var taskSeq:Int
public var templateUID:String
required public init(){}
}
public class ApplyAssemblyResponse : Codable
{
public var responseStatus:ResponseStatus
public var taskSeq:Int
public var templateUID:String?
public var templateName:String
public var quantity:Double
public var unit:String
public var resourcing:TaskResourcing
public var job:EstimateJobResult
public var headline:String
required public init(){}
}
public class TaskResourcing : Codable
{
public var positions:[ResourcedPosition] = []
public var equipment:[ResourcedEquipment] = []
public var materials:[ResourcedMaterial] = []
public var resourcedForQuantity:Double?
public var productionRatePerDay:Double?
public var fixedDays:Double?
required public init(){}
}
public class ResourcedPosition : Codable
{
public var positionTag:String
public var hours:Double?
public var crewSize:Double?
public var utilization:Double?
public var fixedDays: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 utilization:Double?
public var fixedDays: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 quantityPerUnit: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 EstimateJobResult : Codable
{
public var seq:Int
public var dependsOn:[Int] = []
public var itemNo:String
public var name:String
public var category:String
public var sourceRef:String
public var unit:String
public var quantity:Double
public var patternCode:String
public var workdays:Int
public var hoursPerDay:Double
public var isNight:Bool
public var weeklyHours:Double
public var otFraction:Double
public var days:Double
public var effectiveProdPerDay:Double?
public var crewPremiumApplied:Bool
public var workPackage:WorkPackageView
public var crew:[EstimateCrewLineResult] = []
public var equipment:[EstimateEquipmentLineResult] = []
public var materials:[EstimateMaterialLineResult] = []
public var subcontracts:[EstimateSubcontractLine] = []
public var crewCost:Double
public var fringeCost:Double
public var equipmentCost:Double
public var materialCost:Double
public var subcontractCost:Double
public var direct:Double
public var pricingBasis:String
public var pricingRuleId:String
public var pricingBandP25:Double?
public var pricingBandP75:Double?
public var pricingBandN:Int?
public var pricingBandLabel:String
public var benchmarkUnitPrice:Double?
public var benchmarkRateMin:Double?
public var benchmarkRateMax:Double?
public var benchmarkSampleSize:Int?
public var benchmarkP25:Double?
public var benchmarkP75:Double?
public var benchmarkBasis:String
public var unitPriceOverride:Double?
public var overrideBasis:String
public var referencePrice:Double?
public var referenceRangeMin:Double?
public var referenceRangeMax:Double?
public var referenceN:Int?
public var referenceDate:Date?
public var referenceBasis:String
public var referenceUrl:String
required public init(){}
}
public class WorkPackageView : Codable
{
public var hasPackage:Bool
public var scope:String
public var limitsOfWork:String
public var specRefs:[SpecRefView] = []
public var constraints:[String] = []
public var holdPoints:[String] = []
public var dod:[DodItemView] = []
public var safetyNote:String
public var provenance:String
public var specBook:String
public var userEdited:Bool
public var redraftNote:String
required public init(){}
}
public class SpecRefView : Codable
{
public var section:String
public var title:String
public var url:String
required public init(){}
}
public class DodItemView : Codable
{
public var key:String
public var text:String
public var checked:Bool
public var source:String
required public init(){}
}
public class EstimateCrewLineResult : Codable
{
public var role:String
public var hours:Double
public var stHours:Double
public var otHours:Double
public var rrop:Double
public var stCost:Double
public var otCost:Double
public var cost:Double
public var fringeCost:Double
public var premiumApplied:Bool
public var hasOt:Bool
public var needsRate:Bool
required public init(){}
}
public class EstimateEquipmentLineResult : Codable
{
public var name:String
public var quantity:Double
public var rate:Double?
public var needsRate:Bool
public var mobCost:Double
public var cost:Double
public var isAvailabilityTracked:Bool
public var isOwned:Bool
public var availabilityLabel:String
public var freedFromProject:String
public var availableFrom:Date?
public var rateKey:String
public var rentalExplain:String
public var usageDays:Double
public var billedDays:Double
required public init(){}
}
public class EstimateMaterialLineResult : Codable
{
public var name:String
public var quantity:Double
public var unit:String
public var rate:Double?
public var needsRate:Bool
public var cost:Double
public var rateKey:String
required public init(){}
}
public class EstimateSubcontractLine : Codable
{
public var vendor:String
public var amount:Double
public var scope:String
required public init(){}
}
Swift ApplyAssemblyRequest 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.
POST /v1/Rfp/{RfpDocumentUID}/Estimate/Jobs/{TaskSeq}/assembly HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ApplyAssemblyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
<TaskSeq>0</TaskSeq>
<TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
</ApplyAssemblyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ApplyAssemblyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Headline>String</Headline>
<Job>
<BenchmarkBasis>String</BenchmarkBasis>
<BenchmarkP25>0</BenchmarkP25>
<BenchmarkP75>0</BenchmarkP75>
<BenchmarkRateMax>0</BenchmarkRateMax>
<BenchmarkRateMin>0</BenchmarkRateMin>
<BenchmarkSampleSize>0</BenchmarkSampleSize>
<BenchmarkUnitPrice>0</BenchmarkUnitPrice>
<Category>String</Category>
<Crew>
<EstimateCrewLineResult>
<Cost>0</Cost>
<FringeCost>0</FringeCost>
<HasOt>false</HasOt>
<Hours>0</Hours>
<NeedsRate>false</NeedsRate>
<OtCost>0</OtCost>
<OtHours>0</OtHours>
<PremiumApplied>false</PremiumApplied>
<Role>String</Role>
<Rrop>0</Rrop>
<StCost>0</StCost>
<StHours>0</StHours>
</EstimateCrewLineResult>
</Crew>
<CrewCost>0</CrewCost>
<CrewPremiumApplied>false</CrewPremiumApplied>
<Days>0</Days>
<DependsOn xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</DependsOn>
<Direct>0</Direct>
<EffectiveProdPerDay>0</EffectiveProdPerDay>
<Equipment>
<EstimateEquipmentLineResult>
<AvailabilityLabel>String</AvailabilityLabel>
<AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
<BilledDays>0</BilledDays>
<Cost>0</Cost>
<FreedFromProject>String</FreedFromProject>
<IsAvailabilityTracked>false</IsAvailabilityTracked>
<IsOwned>false</IsOwned>
<MobCost>0</MobCost>
<Name>String</Name>
<NeedsRate>false</NeedsRate>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateKey>String</RateKey>
<RentalExplain>String</RentalExplain>
<UsageDays>0</UsageDays>
</EstimateEquipmentLineResult>
</Equipment>
<EquipmentCost>0</EquipmentCost>
<FringeCost>0</FringeCost>
<HoursPerDay>0</HoursPerDay>
<IsNight>false</IsNight>
<ItemNo>String</ItemNo>
<MaterialCost>0</MaterialCost>
<Materials>
<EstimateMaterialLineResult>
<Cost>0</Cost>
<Name>String</Name>
<NeedsRate>false</NeedsRate>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateKey>String</RateKey>
<Unit>String</Unit>
</EstimateMaterialLineResult>
</Materials>
<Name>String</Name>
<OtFraction>0</OtFraction>
<OverrideBasis>String</OverrideBasis>
<PatternCode>String</PatternCode>
<PricingBandLabel>String</PricingBandLabel>
<PricingBandN>0</PricingBandN>
<PricingBandP25>0</PricingBandP25>
<PricingBandP75>0</PricingBandP75>
<PricingBasis>String</PricingBasis>
<PricingRuleId>String</PricingRuleId>
<Quantity>0</Quantity>
<ReferenceBasis>String</ReferenceBasis>
<ReferenceDate>0001-01-01T00:00:00</ReferenceDate>
<ReferenceN>0</ReferenceN>
<ReferencePrice>0</ReferencePrice>
<ReferenceRangeMax>0</ReferenceRangeMax>
<ReferenceRangeMin>0</ReferenceRangeMin>
<ReferenceUrl>String</ReferenceUrl>
<Seq>0</Seq>
<SourceRef>String</SourceRef>
<SubcontractCost>0</SubcontractCost>
<Subcontracts>
<EstimateSubcontractLine>
<Amount>0</Amount>
<Scope>String</Scope>
<Vendor>String</Vendor>
</EstimateSubcontractLine>
</Subcontracts>
<Unit>String</Unit>
<UnitPriceOverride>0</UnitPriceOverride>
<WeeklyHours>0</WeeklyHours>
<WorkPackage>
<Constraints xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Constraints>
<Dod>
<RfpWorkPackageService.DodItemView>
<Checked>false</Checked>
<Key>String</Key>
<Source>String</Source>
<Text>String</Text>
</RfpWorkPackageService.DodItemView>
</Dod>
<HasPackage>false</HasPackage>
<HoldPoints xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</HoldPoints>
<LimitsOfWork>String</LimitsOfWork>
<Provenance>String</Provenance>
<RedraftNote>String</RedraftNote>
<SafetyNote>String</SafetyNote>
<Scope>String</Scope>
<SpecBook>String</SpecBook>
<SpecRefs>
<RfpWorkPackageService.SpecRefView>
<Section>String</Section>
<Title>String</Title>
<Url>String</Url>
</RfpWorkPackageService.SpecRefView>
</SpecRefs>
<UserEdited>false</UserEdited>
</WorkPackage>
<Workdays>0</Workdays>
</Job>
<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>
<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>
<TaskSeq>0</TaskSeq>
<TemplateName>String</TemplateName>
<TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
<Unit>String</Unit>
</ApplyAssemblyResponse>