Trendsic Platform Service

<back to all web services

RfpBriefRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Brief
RfpBriefRequest Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentUIDpathGuidNo
RfpBriefResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RfpDocumentIDformintNo
BriefformRfpBriefNo
RfpBrief Parameters:
NameParameterData TypeRequiredDescription
ProjectTitleformstringNo
SolicitationNumberformstringNo
IssuingOrganizationformstringNo
ProjectTypeformstringNo
SummaryformstringNo
LocationsformList<RfpLocation>No
ScheduleformRfpScheduleNo
LineItemsformList<RfpLineItem>No
BidConstraintsformList<RfpBidConstraint>No
SpecialRequirementsformList<string>No
RfpLocation Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
CityformstringNo
StateformstringNo
IdentifierformstringNo
RfpSchedule Parameters:
NameParameterData TypeRequiredDescription
BidDueDateformstringNo
EstimatedStartDateformstringNo
QuestionsDueDateformstringNo
ContractDurationDaysformint?No
NotesformstringNo
RfpLineItem Parameters:
NameParameterData TypeRequiredDescription
ItemNumberformstringNo
DescriptionformstringNo
Quantityformdouble?No
UnitformstringNo
CategoryformstringNo
SourceReferenceformstringNo
RfpBidConstraint Parameters:
NameParameterData TypeRequiredDescription
ConstraintformstringNo
DetailformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		]
	}
}