| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
RfpDocumentID: 0,
Brief:
{
ProjectTitle: String,
SolicitationNumber: String,
IssuingOrganization: String,
ProjectType: String,
Summary: String,
Locations:
[
{
Description: String,
City: String,
State: String,
Identifier: String
}
],
Schedule:
{
BidDueDate: String,
EstimatedStartDate: String,
QuestionsDueDate: String,
ContractDurationDays: 0,
Notes: String
},
LineItems:
[
{
ItemNumber: String,
Description: String,
Quantity: 0,
Unit: String,
Category: String,
SourceReference: String
}
],
BidConstraints:
[
{
Constraint: String,
Detail: String
}
],
SpecialRequirements:
[
String
]
}
}