Trendsic Platform Service

RfpRefineRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/Rfp/{RfpDocumentUID}/Refine

**RfpRefineRequest** Parameters:
Name	Parameter	Data Type	Required
RfpDocumentUID	path	string	No
Layer	body	string	No
Mode	body	string	No
Instruction	body	string	No

**RfpRefineResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
RfpDocumentID	form	int	No
Layer	form	string	No
Mode	form	string	No
TurnCount	form	int	No
Brief	form	RfpBrief	No
Proposal	form	ProjectProposal	No
Pricing	form	PricedProposal	No
CrewPlan	form	List<CrewPlanLine>	No
CacheReadTokens	form	long	No
CacheCreationTokens	form	long	No
InputTokens	form	long	No

**RfpBrief** Parameters:
Name	Parameter	Data Type	Required
ProjectTitle	form	string	No
SolicitationNumber	form	string	No
IssuingOrganization	form	string	No
ProjectType	form	string	No
Summary	form	string	No
Locations	form	List<RfpLocation>	No
Schedule	form	RfpSchedule	No
LineItems	form	List<RfpLineItem>	No
BidConstraints	form	List<RfpBidConstraint>	No
SpecialRequirements	form	List<string>	No

**RfpLocation** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
City	form	string	No
State	form	string	No
Identifier	form	string	No

**RfpSchedule** Parameters:
Name	Parameter	Data Type	Required
BidDueDate	form	string	No
EstimatedStartDate	form	string	No
QuestionsDueDate	form	string	No
ContractDurationDays	form	int?	No
Notes	form	string	No

**RfpLineItem** Parameters:
Name	Parameter	Data Type	Required
ItemNumber	form	string	No
Description	form	string	No
Quantity	form	double?	No
Unit	form	string	No
Category	form	string	No
SourceReference	form	string	No

**RfpBidConstraint** Parameters:
Name	Parameter	Data Type	Required	Description
Constraint	form	string	No
Detail	form	string	No

**ProjectProposal** Parameters:
Name	Parameter	Data Type	Required
RfpDocumentID	form	int	No
Mode	form	string	No
ProjectID	form	int?	No
ChangeOrderID	form	int?	No
ProjectName	form	string	No
ClientName	form	string	No
ProjectType	form	string	No
ProjectLocation	form	string	No
Scope	form	string	No
ProjectDescription	form	string	No
ContractDurationDays	form	int?	No
BidDueDate	form	string	No
EstimatedStartDate	form	DateTime?	No
EstimatedEndDate	form	DateTime?	No
Tasks	form	List<ProposedTask>	No

**ProposedTask** Parameters:
Name	Parameter	Data Type	Required
Seq	form	int	No
Name	form	string	No
Category	form	string	No
Quantity	form	double?	No
Unit	form	string	No
SourceItemNumber	form	string	No
SourceReference	form	string	No
Notes	form	string	No
Resourcing	form	TaskResourcing	No
DurationDays	form	double?	No
DependsOn	form	List<int>	No
EstimatedStartDate	form	DateTime?	No
EstimatedEndDate	form	DateTime?	No

**TaskResourcing** Parameters:
Name	Parameter	Data Type	Required
Positions	form	List<ResourcedPosition>	No
Equipment	form	List<ResourcedEquipment>	No
Materials	form	List<ResourcedMaterial>	No

**ResourcedPosition** Parameters:
Name	Parameter	Data Type	Required
PositionTag	form	string	No
Hours	form	double?	No
Headcount	form	int?	No
SourceReference	form	string	No
Notes	form	string	No
IsInCatalog	form	bool	No
ContactID	form	int?	No

**ResourcedEquipment** Parameters:
Name	Parameter	Data Type	Required
EquipmentID	form	int	No
EquipmentName	form	string	No
MakeModel	form	string	No
Quantity	form	double?	No
DurationDays	form	double?	No
SourceReference	form	string	No
Notes	form	string	No
IsInCatalog	form	bool	No
SuggestedEquipmentID	form	int	No
SuggestedEquipmentName	form	string	No

**ResourcedMaterial** Parameters:
Name	Parameter	Data Type	Required
MaterialID	form	int	No
MaterialName	form	string	No
MakeModel	form	string	No
Quantity	form	double?	No
Unit	form	string	No
SourceReference	form	string	No
Notes	form	string	No
IsInCatalog	form	bool	No
SuggestedMaterialID	form	int	No
SuggestedMaterialName	form	string	No

**PricedProposal** Parameters:
Name	Parameter	Data Type	Required
RfpDocumentID	form	int	No
ProjectName	form	string	No
Currency	form	string	No
Tasks	form	List<PricedTask>	No
Total	form	CostRange	No
PositionsNeedingRate	form	int	No
EquipmentNotInCatalog	form	int	No
MaterialsNotInCatalog	form	int	No
PositionsNotInCatalog	form	int	No
EquipmentMargin	form	double	No

**PricedTask** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Category	form	string	No
Positions	form	List<PricedPosition>	No
Equipment	form	List<PricedEquipment>	No
Materials	form	List<PricedMaterial>	No
Subtotal	form	CostRange	No

**PricedPosition** Parameters:
Name	Parameter	Data Type	Required
PositionTag	form	string	No
Hours	form	double	No
HasInternalRate	form	bool	No
RateMin	form	double?	No
RateMax	form	double?	No
RateAvg	form	double?	No
ContactCount	form	int	No
Cost	form	CostRange	No
MarketRateReference	form	double?	No

**CostRange** Parameters:
Name	Parameter	Data Type	Required
Min	form	double	No
Max	form	double	No
Mid	form	double	No

**PricedEquipment** Parameters:
Name	Parameter	Data Type	Required
EquipmentID	form	int	No
EquipmentName	form	string	No
Quantity	form	double	No
DurationDays	form	double?	No
RateType	form	string	No
BilledRate	form	double?	No
CostRate	form	double?	No
HasRate	form	bool	No
IsInCatalog	form	bool	No
Cost	form	double	No
CompanyCost	form	double	No
Margin	form	double	No

**PricedMaterial** Parameters:
Name	Parameter	Data Type	Required
MaterialID	form	int	No
MaterialName	form	string	No
Quantity	form	double	No
UnitCost	form	double?	No
HasRate	form	bool	No
IsInCatalog	form	bool	No
Cost	form	double	No

**CrewPlanLine** Parameters:
Name	Parameter	Data Type	Required
PositionTag	form	string	No
Needed	form	int	No
NaiveTotal	form	int	No
TaskAssignments	form	int	No

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/{RfpDocumentUID}/Refine HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RfpDocumentUID: String,
	Layer: String,
	Mode: String,
	Instruction: String
}

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,
	Layer: String,
	Mode: String,
	TurnCount: 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
		]
	},
	Proposal: 
	{
		RfpDocumentID: 0,
		Mode: String,
		ProjectID: 0,
		ChangeOrderID: 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
			}
		]
	},
	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
	},
	CrewPlan: 
	[
		{
			PositionTag: String,
			Needed: 0,
			NaiveTotal: 0,
			TaskAssignments: 0
		}
	],
	CacheReadTokens: 0,
	CacheCreationTokens: 0,
	InputTokens: 0
}