| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Approve |
|---|
import Foundation
import ServiceStack
public class RfpApproveRequest : Codable
{
public var rfpDocumentUID:String
public var proposal:ProjectProposal
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] = []
public var pendingAddendaDiffs:[AddendaChangeSet] = []
public var wageDeterminations:[WageDeterminationResult] = []
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?
public var workPackage:TaskWorkPackage
public var createdJobID:Int?
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 TaskWorkPackage : Codable
{
public var scope:String
public var limitsOfWork:String
public var specRefs:[WorkPackageSpecRef] = []
public var constraints:[String] = []
public var holdPoints:[String] = []
public var definitionOfDone:[String] = []
public var safetyNote:String
public var rfpRef:String
public var confidence:Int?
public var specBook:String
public var userScope:String
public var dodRemoved:[Int] = []
public var dodExtra:[String] = []
public var userEdited:Bool
public var dodChecked:[String] = []
public var redraftNote:String
required public init(){}
}
public class WorkPackageSpecRef : Codable
{
public var section:String
public var title:String
required public init(){}
}
public class AddendaChangeSet : Codable
{
public var changeSetId:String
public var sourceRfpDocumentID:Int
public var sourceFileName:String
public var documentType:String
public var extractedAtUtc:Date?
public var summary:String
public var changes:[AddendaChange] = []
required public init(){}
}
public class AddendaChange : Codable
{
public var changeId:String
public var changeType:String
public var targetSeq:Int?
public var itemNumber:String
public var itemName:String
public var field:String
public var oldValue:String
public var newValue:String
public var Description:String
public var status:String
required public init(){}
}
public class WageDeterminationResult : Codable
{
public var sourceRfpDocumentID:Int
public var sourceFileName:String
public var wdNumber:String
public var extractedAtUtc:Date?
public var classifications:[WageClassification] = []
public var source:String
public var isTrustworthy:Bool
public var executiveOrderFloor:Double?
public var publishedDate:String
public var projectParish:String
public var warnings:[String] = []
required public init(){}
}
public class WageClassification : Codable
{
public var title:String
public var baseRate:Double?
public var fringeRate:Double?
public var parishNote:String
public var sourceLine:String
public var benchmarkFringeRate:Double?
public var fringeCompareNote:String
required public init(){}
}
public class RfpApproveResponse : Codable
{
public var responseStatus:ResponseStatus
public var rfpDocumentID:Int
public var projectID:Int
public var projectUID:String
public var rfpApprovalID:Int
public var jobIDs:[Int] = []
public var openPositionCount:Int
public var diff:ProposalDiff
required public init(){}
}
public class ProposalDiff : Codable
{
public var tasksAdded:[String] = []
public var tasksRemoved:[String] = []
public var tasks:[TaskDiff] = []
public var hasChanges:Bool
required public init(){}
}
public class TaskDiff : Codable
{
public var taskName:String
public var positionsAdded:[String] = []
public var positionsRemoved:[String] = []
public var positionsStaffed:[String] = []
public var equipmentAdded:[Int] = []
public var equipmentRemoved:[Int] = []
public var materialsAdded:[Int] = []
public var materialsRemoved:[Int] = []
public var hasChanges:Bool
required public init(){}
}
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}/Approve HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RfpApproveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<PendingAddendaDiffs>
<AddendaChangeSet>
<ChangeSetId>String</ChangeSetId>
<Changes>
<AddendaChange>
<ChangeId>String</ChangeId>
<ChangeType>String</ChangeType>
<Description>String</Description>
<Field>String</Field>
<ItemName>String</ItemName>
<ItemNumber>String</ItemNumber>
<NewValue>String</NewValue>
<OldValue>String</OldValue>
<Status>String</Status>
<TargetSeq>0</TargetSeq>
</AddendaChange>
</Changes>
<DocumentType>String</DocumentType>
<ExtractedAtUtc>0001-01-01T00:00:00</ExtractedAtUtc>
<SourceFileName>String</SourceFileName>
<SourceRfpDocumentID>0</SourceRfpDocumentID>
<Summary>String</Summary>
</AddendaChangeSet>
</PendingAddendaDiffs>
<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>
<CreatedJobID>0</CreatedJobID>
<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>
<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>
<Seq>0</Seq>
<SourceItemNumber>String</SourceItemNumber>
<SourceReference>String</SourceReference>
<Unit>String</Unit>
<WorkPackage>
<Confidence>0</Confidence>
<Constraints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</Constraints>
<DefinitionOfDone xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DefinitionOfDone>
<DodChecked xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DodChecked>
<DodExtra xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</DodExtra>
<DodRemoved xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>0</d6p1:int>
</DodRemoved>
<HoldPoints xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</HoldPoints>
<LimitsOfWork>String</LimitsOfWork>
<RedraftNote>String</RedraftNote>
<RfpRef>String</RfpRef>
<SafetyNote>String</SafetyNote>
<Scope>String</Scope>
<SpecBook>String</SpecBook>
<SpecRefs>
<WorkPackageSpecRef>
<Section>String</Section>
<Title>String</Title>
</WorkPackageSpecRef>
</SpecRefs>
<UserEdited>false</UserEdited>
<UserScope>String</UserScope>
</WorkPackage>
</ProposedTask>
</Tasks>
<WageDeterminations>
<WageDeterminationResult>
<Classifications>
<WageClassification>
<BaseRate>0</BaseRate>
<BenchmarkFringeRate>0</BenchmarkFringeRate>
<FringeCompareNote>String</FringeCompareNote>
<FringeRate>0</FringeRate>
<ParishNote>String</ParishNote>
<SourceLine>String</SourceLine>
<Title>String</Title>
</WageClassification>
</Classifications>
<ExecutiveOrderFloor>0</ExecutiveOrderFloor>
<ExtractedAtUtc>0001-01-01T00:00:00</ExtractedAtUtc>
<IsTrustworthy>false</IsTrustworthy>
<ProjectParish>String</ProjectParish>
<PublishedDate>String</PublishedDate>
<Source>String</Source>
<SourceFileName>String</SourceFileName>
<SourceRfpDocumentID>0</SourceRfpDocumentID>
<Warnings xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Warnings>
<WdNumber>String</WdNumber>
</WageDeterminationResult>
</WageDeterminations>
</Proposal>
<RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
</RfpApproveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RfpApproveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Diff>
<Tasks>
<TaskDiff>
<EquipmentAdded xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</EquipmentAdded>
<EquipmentRemoved xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</EquipmentRemoved>
<MaterialsAdded xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</MaterialsAdded>
<MaterialsRemoved xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</MaterialsRemoved>
<PositionsAdded xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</PositionsAdded>
<PositionsRemoved xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</PositionsRemoved>
<PositionsStaffed xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</PositionsStaffed>
<TaskName>String</TaskName>
</TaskDiff>
</Tasks>
<TasksAdded xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</TasksAdded>
<TasksRemoved xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</TasksRemoved>
</Diff>
<JobIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</JobIDs>
<OpenPositionCount>0</OpenPositionCount>
<ProjectID>0</ProjectID>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<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>
<RfpApprovalID>0</RfpApprovalID>
<RfpDocumentID>0</RfpDocumentID>
</RfpApproveResponse>