| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Brief |
|---|
"use strict";
export class RfpLocation {
/** @param {{Description?:string,City?:string,State?:string,Identifier?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {string} */
City;
/** @type {string} */
State;
/** @type {string} */
Identifier;
}
export class RfpSchedule {
/** @param {{BidDueDate?:string,EstimatedStartDate?:string,QuestionsDueDate?:string,ContractDurationDays?:number,Notes?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BidDueDate;
/** @type {string} */
EstimatedStartDate;
/** @type {string} */
QuestionsDueDate;
/** @type {?number} */
ContractDurationDays;
/** @type {string} */
Notes;
}
export class RfpLineItem {
/** @param {{ItemNumber?:string,Description?:string,Quantity?:number,Unit?:string,Category?:string,SourceReference?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ItemNumber;
/** @type {string} */
Description;
/** @type {?number} */
Quantity;
/** @type {string} */
Unit;
/** @type {string} */
Category;
/** @type {string} */
SourceReference;
}
export class RfpBidConstraint {
/** @param {{Constraint?:string,Detail?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Constraint;
/** @type {string} */
Detail;
}
export class RfpBrief {
/** @param {{ProjectTitle?:string,SolicitationNumber?:string,IssuingOrganization?:string,ProjectType?:string,Summary?:string,Locations?:RfpLocation[],Schedule?:RfpSchedule,LineItems?:RfpLineItem[],BidConstraints?:RfpBidConstraint[],SpecialRequirements?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ProjectTitle;
/** @type {string} */
SolicitationNumber;
/** @type {string} */
IssuingOrganization;
/** @type {string} */
ProjectType;
/** @type {string} */
Summary;
/** @type {RfpLocation[]} */
Locations = [];
/** @type {RfpSchedule} */
Schedule;
/** @type {RfpLineItem[]} */
LineItems = [];
/** @type {RfpBidConstraint[]} */
BidConstraints = [];
/** @type {string[]} */
SpecialRequirements = [];
}
export class RfpBriefResponse {
/** @param {{ResponseStatus?:ResponseStatus,RfpDocumentID?:number,Brief?:RfpBrief}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {number} */
RfpDocumentID;
/** @type {RfpBrief} */
Brief;
}
export class RfpBriefRequest {
/** @param {{RfpDocumentUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RfpDocumentUID;
}
JavaScript RfpBriefRequest 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.
GET /v1/Rfp/{RfpDocumentUID}/Brief HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RfpBriefResponse 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>
<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>
</RfpBriefResponse>