Trendsic Platform Service

<back to all web services

RfpPricePreviewRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/PricePreview
RfpPricePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
ProposalbodyProjectProposalNo
ProjectProposal Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentIDformintNo
ProjectNameformstringNo
ClientNameformstringNo
ProjectTypeformstringNo
ProjectLocationformstringNo
ScopeformstringNo
ProjectDescriptionformstringNo
ContractDurationDaysformint?No
BidDueDateformstringNo
EstimatedStartDateformDateTime?No
EstimatedEndDateformDateTime?No
TasksformList<ProposedTask>No
ProposedTask Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
NameformstringNo
CategoryformstringNo
Quantityformdouble?No
UnitformstringNo
SourceItemNumberformstringNo
SourceReferenceformstringNo
NotesformstringNo
ResourcingformTaskResourcingNo
DurationDaysformdouble?No
DependsOnformList<int>No
EstimatedStartDateformDateTime?No
EstimatedEndDateformDateTime?No
TaskResourcing Parameters:
NameParameterData TypeRequiredDescription
PositionsformList<ResourcedPosition>No
EquipmentformList<ResourcedEquipment>No
MaterialsformList<ResourcedMaterial>No
ResourcedPosition Parameters:
NameParameterData TypeRequiredDescription
PositionTagformstringNo
Hoursformdouble?No
Headcountformint?No
SourceReferenceformstringNo
NotesformstringNo
IsInCatalogformboolNo
ContactIDformint?No
ResourcedEquipment Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
EquipmentNameformstringNo
MakeModelformstringNo
Quantityformdouble?No
DurationDaysformdouble?No
SourceReferenceformstringNo
NotesformstringNo
IsInCatalogformboolNo
SuggestedEquipmentIDformintNo
SuggestedEquipmentNameformstringNo
ResourcedMaterial Parameters:
NameParameterData TypeRequiredDescription
MaterialIDformintNo
MaterialNameformstringNo
MakeModelformstringNo
Quantityformdouble?No
UnitformstringNo
SourceReferenceformstringNo
NotesformstringNo
IsInCatalogformboolNo
SuggestedMaterialIDformintNo
SuggestedMaterialNameformstringNo
RfpPricingResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RfpDocumentIDformintNo
PricingformPricedProposalNo
PricedProposal Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentIDformintNo
ProjectNameformstringNo
CurrencyformstringNo
TasksformList<PricedTask>No
TotalformCostRangeNo
PositionsNeedingRateformintNo
EquipmentNotInCatalogformintNo
MaterialsNotInCatalogformintNo
PositionsNotInCatalogformintNo
EquipmentMarginformdoubleNo
PricedTask Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
CategoryformstringNo
PositionsformList<PricedPosition>No
EquipmentformList<PricedEquipment>No
MaterialsformList<PricedMaterial>No
SubtotalformCostRangeNo
PricedPosition Parameters:
NameParameterData TypeRequiredDescription
PositionTagformstringNo
HoursformdoubleNo
HasInternalRateformboolNo
RateMinformdouble?No
RateMaxformdouble?No
RateAvgformdouble?No
ContactCountformintNo
CostformCostRangeNo
MarketRateReferenceformdouble?No
CostRange Parameters:
NameParameterData TypeRequiredDescription
MinformdoubleNo
MaxformdoubleNo
MidformdoubleNo
PricedEquipment Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
EquipmentNameformstringNo
QuantityformdoubleNo
DurationDaysformdouble?No
RateTypeformstringNo
BilledRateformdouble?No
CostRateformdouble?No
HasRateformboolNo
IsInCatalogformboolNo
CostformdoubleNo
CompanyCostformdoubleNo
MarginformdoubleNo
PricedMaterial Parameters:
NameParameterData TypeRequiredDescription
MaterialIDformintNo
MaterialNameformstringNo
QuantityformdoubleNo
UnitCostformdouble?No
HasRateformboolNo
IsInCatalogformboolNo
CostformdoubleNo

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.

POST /v1/Rfp/PricePreview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Proposal: 
	{
		RfpDocumentID: 0,
		ProjectName: String,
		ClientName: String,
		ProjectType: String,
		ProjectLocation: String,
		Scope: String,
		ProjectDescription: String,
		ContractDurationDays: 0,
		BidDueDate: String,
		EstimatedStartDate: 0001-01-01,
		EstimatedEndDate: 0001-01-01,
		Tasks: 
		[
			{
				Seq: 0,
				Name: String,
				Category: String,
				Quantity: 0,
				Unit: String,
				SourceItemNumber: String,
				SourceReference: String,
				Notes: String,
				Resourcing: 
				{
					Positions: 
					[
						{
							PositionTag: String,
							Hours: 0,
							Headcount: 0,
							SourceReference: String,
							Notes: String,
							IsInCatalog: False,
							ContactID: 0
						}
					],
					Equipment: 
					[
						{
							EquipmentID: 0,
							EquipmentName: String,
							MakeModel: String,
							Quantity: 0,
							DurationDays: 0,
							SourceReference: String,
							Notes: String,
							IsInCatalog: False,
							SuggestedEquipmentID: 0,
							SuggestedEquipmentName: String
						}
					],
					Materials: 
					[
						{
							MaterialID: 0,
							MaterialName: String,
							MakeModel: String,
							Quantity: 0,
							Unit: String,
							SourceReference: String,
							Notes: String,
							IsInCatalog: False,
							SuggestedMaterialID: 0,
							SuggestedMaterialName: String
						}
					]
				},
				DurationDays: 0,
				DependsOn: 
				[
					0
				],
				EstimatedStartDate: 0001-01-01,
				EstimatedEndDate: 0001-01-01
			}
		]
	}
}
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,
	Pricing: 
	{
		RfpDocumentID: 0,
		ProjectName: String,
		Currency: String,
		Tasks: 
		[
			{
				Name: String,
				Category: String,
				Positions: 
				[
					{
						PositionTag: String,
						Hours: 0,
						HasInternalRate: False,
						RateMin: 0,
						RateMax: 0,
						RateAvg: 0,
						ContactCount: 0,
						Cost: 
						{
							Min: 0,
							Max: 0,
							Mid: 0
						},
						MarketRateReference: 0
					}
				],
				Equipment: 
				[
					{
						EquipmentID: 0,
						EquipmentName: String,
						Quantity: 0,
						DurationDays: 0,
						RateType: String,
						BilledRate: 0,
						CostRate: 0,
						HasRate: False,
						IsInCatalog: False,
						Cost: 0,
						CompanyCost: 0,
						Margin: 0
					}
				],
				Materials: 
				[
					{
						MaterialID: 0,
						MaterialName: String,
						Quantity: 0,
						UnitCost: 0,
						HasRate: False,
						IsInCatalog: False,
						Cost: 0
					}
				],
				Subtotal: 
				{
					Min: 0,
					Max: 0,
					Mid: 0
				}
			}
		],
		Total: 
		{
			Min: 0,
			Max: 0,
			Mid: 0
		},
		PositionsNeedingRate: 0,
		EquipmentNotInCatalog: 0,
		MaterialsNotInCatalog: 0,
		PositionsNotInCatalog: 0,
		EquipmentMargin: 0
	}
}