| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Approve |
|---|
"use strict";
export class TaskDiff {
/** @param {{TaskName?:string,PositionsAdded?:string[],PositionsRemoved?:string[],PositionsStaffed?:string[],EquipmentAdded?:number[],EquipmentRemoved?:number[],MaterialsAdded?:number[],MaterialsRemoved?:number[],HasChanges?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TaskName;
/** @type {string[]} */
PositionsAdded = [];
/** @type {string[]} */
PositionsRemoved = [];
/** @type {string[]} */
PositionsStaffed = [];
/** @type {number[]} */
EquipmentAdded = [];
/** @type {number[]} */
EquipmentRemoved = [];
/** @type {number[]} */
MaterialsAdded = [];
/** @type {number[]} */
MaterialsRemoved = [];
/** @type {boolean} */
HasChanges;
}
export class ProposalDiff {
/** @param {{TasksAdded?:string[],TasksRemoved?:string[],Tasks?:TaskDiff[],HasChanges?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string[]} */
TasksAdded = [];
/** @type {string[]} */
TasksRemoved = [];
/** @type {TaskDiff[]} */
Tasks = [];
/** @type {boolean} */
HasChanges;
}
export class RfpApproveResponse {
/** @param {{ResponseStatus?:ResponseStatus,RfpDocumentID?:number,ProjectID?:number,ProjectUID?:string,RfpApprovalID?:number,JobIDs?:number[],OpenPositionCount?:number,Diff?:ProposalDiff}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {number} */
RfpDocumentID;
/** @type {number} */
ProjectID;
/** @type {string} */
ProjectUID;
/** @type {number} */
RfpApprovalID;
/** @type {number[]} */
JobIDs = [];
/** @type {number} */
OpenPositionCount;
/** @type {ProposalDiff} */
Diff;
}
export class ResourcedPosition {
/** @param {{PositionTag?:string,Hours?:number,Headcount?:number,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,ContactID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PositionTag;
/** @type {?number} */
Hours;
/** @type {?number} */
Headcount;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {?number} */
ContactID;
}
export class ResourcedEquipment {
/** @param {{EquipmentID?:number,EquipmentName?:string,MakeModel?:string,Quantity?:number,DurationDays?:number,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,SuggestedEquipmentID?:number,SuggestedEquipmentName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
EquipmentID;
/** @type {string} */
EquipmentName;
/** @type {string} */
MakeModel;
/** @type {?number} */
Quantity;
/** @type {?number} */
DurationDays;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {number} */
SuggestedEquipmentID;
/** @type {string} */
SuggestedEquipmentName;
}
export class ResourcedMaterial {
/** @param {{MaterialID?:number,MaterialName?:string,MakeModel?:string,Quantity?:number,Unit?:string,SourceReference?:string,Notes?:string,IsInCatalog?:boolean,SuggestedMaterialID?:number,SuggestedMaterialName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
MaterialID;
/** @type {string} */
MaterialName;
/** @type {string} */
MakeModel;
/** @type {?number} */
Quantity;
/** @type {string} */
Unit;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {boolean} */
IsInCatalog;
/** @type {number} */
SuggestedMaterialID;
/** @type {string} */
SuggestedMaterialName;
}
export class TaskResourcing {
/** @param {{Positions?:ResourcedPosition[],Equipment?:ResourcedEquipment[],Materials?:ResourcedMaterial[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResourcedPosition[]} */
Positions = [];
/** @type {ResourcedEquipment[]} */
Equipment = [];
/** @type {ResourcedMaterial[]} */
Materials = [];
}
export class ProposedTask {
/** @param {{Seq?:number,Name?:string,Category?:string,Quantity?:number,Unit?:string,SourceItemNumber?:string,SourceReference?:string,Notes?:string,Resourcing?:TaskResourcing,DurationDays?:number,DependsOn?:number[],EstimatedStartDate?:string,EstimatedEndDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Seq;
/** @type {string} */
Name;
/** @type {string} */
Category;
/** @type {?number} */
Quantity;
/** @type {string} */
Unit;
/** @type {string} */
SourceItemNumber;
/** @type {string} */
SourceReference;
/** @type {string} */
Notes;
/** @type {TaskResourcing} */
Resourcing;
/** @type {?number} */
DurationDays;
/** @type {number[]} */
DependsOn = [];
/** @type {?string} */
EstimatedStartDate;
/** @type {?string} */
EstimatedEndDate;
}
export class ProjectProposal {
/** @param {{RfpDocumentID?:number,ProjectName?:string,ClientName?:string,ProjectType?:string,ProjectLocation?:string,Scope?:string,ProjectDescription?:string,ContractDurationDays?:number,BidDueDate?:string,EstimatedStartDate?:string,EstimatedEndDate?:string,Tasks?:ProposedTask[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RfpDocumentID;
/** @type {string} */
ProjectName;
/** @type {string} */
ClientName;
/** @type {string} */
ProjectType;
/** @type {string} */
ProjectLocation;
/** @type {string} */
Scope;
/** @type {string} */
ProjectDescription;
/** @type {?number} */
ContractDurationDays;
/** @type {string} */
BidDueDate;
/** @type {?string} */
EstimatedStartDate;
/** @type {?string} */
EstimatedEndDate;
/** @type {ProposedTask[]} */
Tasks = [];
}
export class RfpApproveRequest {
/** @param {{RfpDocumentUID?:string,Proposal?:ProjectProposal}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RfpDocumentUID;
/** @type {ProjectProposal} */
Proposal;
}
JavaScript RfpApproveRequest 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}/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>
<ClientName>String</ClientName>
<ContractDurationDays>0</ContractDurationDays>
<EstimatedEndDate>0001-01-01T00:00:00</EstimatedEndDate>
<EstimatedStartDate>0001-01-01T00:00:00</EstimatedStartDate>
<ProjectDescription>String</ProjectDescription>
<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>
<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>