Trendsic Platform Service

<back to all web services

ApplyStartRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/ApplyStart
ApplyStartRequest Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentUIDpathGuidNo
StartDatebodyDateTimeNo
EstimateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ViewformEstimatingViewNo
EstimatingView Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentIDformintNo
ProjectNameformstringNo
ClientNameformstringNo
BidDueDateformstringNo
ProjectTypeformstringNo
SettingsformEstimateSettingsViewNo
JobsformList<EstimateJobView>No
ScheduleformList<BidScheduleLine>No
ScheduleTotalformdecimalNo
VarianceformEstimateVarianceViewNo
IndicativeformIndicativeBidViewNo
SummaryformEstimateSummaryViewNo
TimingformEstimateTimingViewNo
NeedsRateCountformintNo
NeedsRateKeysformList<string>No
ReviewItemsformList<EstimateReviewItemView>No
NeedsReviewCountformintNo
CanApproveformboolNo
CanSeePayformboolNo
EstimateSettingsView Parameters:
NameParameterData TypeRequiredDescription
RfpEstimateIDformintNo
StartDateformDateTime?No
DeadlineDateformDateTime?No
WorkdaysPerWeekformintNo
HoursPerDayformdecimalNo
WeatherPctformdecimalNo
OhpPctformdecimalNo
ContingencyPctformdecimalNo
BondPctformdecimalNo
HolidaysformList<DateTime>No
AppliedStartDateformDateTime?No
EstimateJobView Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
WorkPackageformWorkPackageViewNo
ItemNoformstringNo
NameformstringNo
CategoryformstringNo
SourceRefformstringNo
UnitformstringNo
QuantityformdecimalNo
PatternCodeformstringNo
WorkdaysformintNo
HoursPerDayformdecimalNo
IsNightformboolNo
WeeklyHoursformdecimalNo
OtFractionformdecimalNo
DaysformdecimalNo
EffectiveProdPerDayformdecimal?No
CrewPremiumAppliedformboolNo
CrewCostformdecimalNo
FringeCostformdecimalNo
EquipmentCostformdecimalNo
MaterialCostformdecimalNo
SubcontractCostformdecimalNo
DirectformdecimalNo
PricingBasisformstringNo
BenchmarkUnitPriceformdecimal?No
CrewformList<EstimateCrewLineView>No
EquipmentformList<EstimateEquipmentLineView>No
MaterialsformList<EstimateMaterialLineView>No
SubcontractsformList<EstimateSubcontractView>No
WorkPackageView Parameters:
NameParameterData TypeRequiredDescription
HasPackageformboolNo
ScopeformstringNo
LimitsOfWorkformstringNo
SpecRefsformList<SpecRefView>No
ConstraintsformList<string>No
HoldPointsformList<string>No
DodformList<DodItemView>No
SafetyNoteformstringNo
ProvenanceformstringNo
SpecBookformstringNo
UserEditedformboolNo
RedraftNoteformstringNo
SpecRefView Parameters:
NameParameterData TypeRequiredDescription
SectionformstringNo
TitleformstringNo
UrlformstringNo
DodItemView Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
TextformstringNo
CheckedformboolNo
SourceformstringNo
EstimateCrewLineView Parameters:
NameParameterData TypeRequiredDescription
RoleformstringNo
HoursformdecimalNo
StHoursformdecimalNo
OtHoursformdecimalNo
HasOtformboolNo
PremiumAppliedformboolNo
NeedsRateformboolNo
RateKeyformstringNo
ChipformstringNo
Rropformdecimal?No
StCostformdecimal?No
OtCostformdecimal?No
Costformdecimal?No
FringeCostformdecimal?No
EstimateEquipmentLineView Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
QuantityformdecimalNo
Rateformdecimal?No
NeedsRateformboolNo
MobCostformdecimalNo
CostformdecimalNo
IsAvailabilityTrackedformboolNo
IsOwnedformboolNo
AvailabilityLabelformstringNo
FreedFromProjectformstringNo
AvailableFromformDateTime?No
RateKeyformstringNo
ChipformstringNo
RentalExplainformstringNo
UsageDaysformdecimalNo
BilledDaysformdecimalNo
EstimateMaterialLineView Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
QuantityformdecimalNo
UnitformstringNo
Rateformdecimal?No
NeedsRateformboolNo
CostformdecimalNo
RateKeyformstringNo
ChipformstringNo
EstimateSubcontractView Parameters:
NameParameterData TypeRequiredDescription
EstimateSubcontractIDformintNo
TaskSeqformintNo
VendorformstringNo
AmountformdecimalNo
ScopeformstringNo
BidScheduleLine Parameters:
NameParameterData TypeRequiredDescription
ItemNoformstringNo
DescriptionformstringNo
UnitformstringNo
QuantityformdecimalNo
UnitPriceformdecimalNo
ExtensionformdecimalNo
PricingBasisformstringNo
BenchmarkDeltaPctformdecimal?No
BenchmarkFlaggedformboolNo
EstimateVarianceView Parameters:
NameParameterData TypeRequiredDescription
LinesformList<EstimateVarianceLine>No
ItemsTotalformintNo
ItemsBenchmarkedformintNo
CoverageValuePctformdecimalNo
OursTotalformdecimalNo
MarketTotalformdecimalNo
AggregateDeltaPctformdecimal?No
FlooredCountformintNo
WatchCountformintNo
OutlierCountformintNo
CriticalCountformintNo
NoteformstringNo
EstimateVarianceLine Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
ItemNoformstringNo
NameformstringNo
UnitformstringNo
QuantityformdecimalNo
OurUnitPriceformdecimalNo
OurTotalformdecimalNo
BenchmarkUnitPriceformdecimalNo
MarketTotalformdecimalNo
DeltaPctformdecimalNo
RateMinformdecimal?No
RateMaxformdecimal?No
SampleSizeformint?No
OutsideRangeformbool?No
IsFloorformboolNo
SeverityformstringNo
NoteformstringNo
IndicativeBidView Parameters:
NameParameterData TypeRequiredDescription
LinesformList<IndicativeLine>No
BottomUpCountformintNo
BottomUpTotalformdecimalNo
BenchmarkCountformintNo
BenchmarkTotalformdecimalNo
UncoveredCountformintNo
UncoveredFloorTotalformdecimalNo
IndicativeTotalformdecimalNo
FloorTotalformdecimalNo
NoteformstringNo
IndicativeLine Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
ItemNoformstringNo
NameformstringNo
UnitformstringNo
QuantityformdecimalNo
SourceformstringNo
UnitPriceformdecimalNo
LineTotalformdecimalNo
EstimateSummaryView Parameters:
NameParameterData TypeRequiredDescription
DirectformdecimalNo
OhpPctformdecimalNo
OhpAmountformdecimalNo
BondPctformdecimalNo
BondAmountformdecimalNo
ContingencyPctformdecimalNo
ContingencyAmountformdecimalNo
BidTotalformdecimalNo
LoadFactorformdecimalNo
MarginPctformdecimalNo
EstimateTimingView Parameters:
NameParameterData TypeRequiredDescription
TotalWorkdaysformdecimalNo
CalendarDaysformintNo
FinishformDateTimeNo
FeasibleformboolNo
DeadlineformDateTime?No
EstimateReviewItemView Parameters:
NameParameterData TypeRequiredDescription
TaskSeqformintNo
TaskNameformstringNo
ReasonformstringNo
StatusformstringNo

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

{
	RfpDocumentUID: 00000000000000000000000000000000,
	StartDate: 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
		}
	},
	View: 
	{
		RfpDocumentID: 0,
		ProjectName: String,
		ClientName: String,
		BidDueDate: String,
		ProjectType: String,
		Settings: 
		{
			RfpEstimateID: 0,
			StartDate: 0001-01-01,
			DeadlineDate: 0001-01-01,
			WorkdaysPerWeek: 0,
			HoursPerDay: 0,
			WeatherPct: 0,
			OhpPct: 0,
			ContingencyPct: 0,
			BondPct: 0,
			Holidays: 
			[
				0001-01-01
			],
			AppliedStartDate: 0001-01-01
		},
		Jobs: 
		[
			{
				Seq: 0,
				WorkPackage: 
				{
					HasPackage: False,
					Scope: String,
					LimitsOfWork: String,
					SpecRefs: 
					[
						{
							Section: String,
							Title: String,
							Url: String
						}
					],
					Constraints: 
					[
						String
					],
					HoldPoints: 
					[
						String
					],
					Dod: 
					[
						{
							Key: String,
							Text: String,
							Checked: False,
							Source: String
						}
					],
					SafetyNote: String,
					Provenance: String,
					SpecBook: String,
					UserEdited: False,
					RedraftNote: String
				},
				ItemNo: String,
				Name: String,
				Category: String,
				SourceRef: String,
				Unit: String,
				Quantity: 0,
				PatternCode: String,
				Workdays: 0,
				HoursPerDay: 0,
				IsNight: False,
				WeeklyHours: 0,
				OtFraction: 0,
				Days: 0,
				EffectiveProdPerDay: 0,
				CrewPremiumApplied: False,
				CrewCost: 0,
				FringeCost: 0,
				EquipmentCost: 0,
				MaterialCost: 0,
				SubcontractCost: 0,
				Direct: 0,
				PricingBasis: String,
				BenchmarkUnitPrice: 0,
				Crew: 
				[
					{
						Role: String,
						Hours: 0,
						StHours: 0,
						OtHours: 0,
						HasOt: False,
						PremiumApplied: False,
						NeedsRate: False,
						RateKey: String,
						Chip: String,
						Rrop: 0,
						StCost: 0,
						OtCost: 0,
						Cost: 0,
						FringeCost: 0
					}
				],
				Equipment: 
				[
					{
						Name: String,
						Quantity: 0,
						Rate: 0,
						NeedsRate: False,
						MobCost: 0,
						Cost: 0,
						IsAvailabilityTracked: False,
						IsOwned: False,
						AvailabilityLabel: String,
						FreedFromProject: String,
						AvailableFrom: 0001-01-01,
						RateKey: String,
						Chip: String,
						RentalExplain: String,
						UsageDays: 0,
						BilledDays: 0
					}
				],
				Materials: 
				[
					{
						Name: String,
						Quantity: 0,
						Unit: String,
						Rate: 0,
						NeedsRate: False,
						Cost: 0,
						RateKey: String,
						Chip: String
					}
				],
				Subcontracts: 
				[
					{
						EstimateSubcontractID: 0,
						TaskSeq: 0,
						Vendor: String,
						Amount: 0,
						Scope: String
					}
				]
			}
		],
		Schedule: 
		[
			{
				ItemNo: String,
				Description: String,
				Unit: String,
				Quantity: 0,
				UnitPrice: 0,
				Extension: 0,
				PricingBasis: String,
				BenchmarkDeltaPct: 0,
				BenchmarkFlagged: False
			}
		],
		ScheduleTotal: 0,
		Variance: 
		{
			Lines: 
			[
				{
					Seq: 0,
					ItemNo: String,
					Name: String,
					Unit: String,
					Quantity: 0,
					OurUnitPrice: 0,
					OurTotal: 0,
					BenchmarkUnitPrice: 0,
					MarketTotal: 0,
					DeltaPct: 0,
					RateMin: 0,
					RateMax: 0,
					SampleSize: 0,
					OutsideRange: False,
					IsFloor: False,
					Severity: String,
					Note: String
				}
			],
			ItemsTotal: 0,
			ItemsBenchmarked: 0,
			CoverageValuePct: 0,
			OursTotal: 0,
			MarketTotal: 0,
			AggregateDeltaPct: 0,
			FlooredCount: 0,
			WatchCount: 0,
			OutlierCount: 0,
			CriticalCount: 0,
			Note: String
		},
		Indicative: 
		{
			Lines: 
			[
				{
					Seq: 0,
					ItemNo: String,
					Name: String,
					Unit: String,
					Quantity: 0,
					Source: String,
					UnitPrice: 0,
					LineTotal: 0
				}
			],
			BottomUpCount: 0,
			BottomUpTotal: 0,
			BenchmarkCount: 0,
			BenchmarkTotal: 0,
			UncoveredCount: 0,
			UncoveredFloorTotal: 0,
			IndicativeTotal: 0,
			FloorTotal: 0,
			Note: String
		},
		Summary: 
		{
			Direct: 0,
			OhpPct: 0,
			OhpAmount: 0,
			BondPct: 0,
			BondAmount: 0,
			ContingencyPct: 0,
			ContingencyAmount: 0,
			BidTotal: 0,
			LoadFactor: 0,
			MarginPct: 0
		},
		Timing: 
		{
			TotalWorkdays: 0,
			CalendarDays: 0,
			Finish: 0001-01-01,
			Feasible: False,
			Deadline: 0001-01-01
		},
		NeedsRateCount: 0,
		NeedsRateKeys: 
		[
			String
		],
		ReviewItems: 
		[
			{
				TaskSeq: 0,
				TaskName: String,
				Reason: String,
				Status: String
			}
		],
		NeedsReviewCount: 0,
		CanApprove: False,
		CanSeePay: False
	}
}