| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/{RfpDocumentUID}/ApplyStart |
|---|
export class EstimateSettingsView
{
public RfpEstimateID: number;
public StartDate?: string;
public DeadlineDate?: string;
public WorkdaysPerWeek: number;
public HoursPerDay: number;
public WeatherPct: number;
public OhpPct: number;
public ContingencyPct: number;
public BondPct: number;
public Holidays: string[] = [];
public AppliedStartDate?: string;
public constructor(init?: Partial<EstimateSettingsView>) { (Object as any).assign(this, init); }
}
export class SpecRefView
{
public Section: string;
public Title: string;
public Url: string;
public constructor(init?: Partial<SpecRefView>) { (Object as any).assign(this, init); }
}
export class DodItemView
{
public Key: string;
public Text: string;
public Checked: boolean;
public Source: string;
public constructor(init?: Partial<DodItemView>) { (Object as any).assign(this, init); }
}
export class WorkPackageView
{
public HasPackage: boolean;
public Scope: string;
public LimitsOfWork: string;
public SpecRefs: SpecRefView[] = [];
public Constraints: string[] = [];
public HoldPoints: string[] = [];
public Dod: DodItemView[] = [];
public SafetyNote: string;
public Provenance: string;
public SpecBook: string;
public UserEdited: boolean;
public RedraftNote: string;
public constructor(init?: Partial<WorkPackageView>) { (Object as any).assign(this, init); }
}
export class EstimateCrewLineView
{
public Role: string;
public Hours: number;
public StHours: number;
public OtHours: number;
public HasOt: boolean;
public PremiumApplied: boolean;
public NeedsRate: boolean;
public RateKey: string;
public Chip: string;
public Rrop?: number;
public StCost?: number;
public OtCost?: number;
public Cost?: number;
public FringeCost?: number;
public constructor(init?: Partial<EstimateCrewLineView>) { (Object as any).assign(this, init); }
}
export class EstimateEquipmentLineView
{
public Name: string;
public Quantity: number;
public Rate?: number;
public NeedsRate: boolean;
public MobCost: number;
public Cost: number;
public IsAvailabilityTracked: boolean;
public IsOwned: boolean;
public AvailabilityLabel: string;
public FreedFromProject: string;
public AvailableFrom?: string;
public RateKey: string;
public Chip: string;
public RentalExplain: string;
public UsageDays: number;
public BilledDays: number;
public constructor(init?: Partial<EstimateEquipmentLineView>) { (Object as any).assign(this, init); }
}
export class EstimateMaterialLineView
{
public Name: string;
public Quantity: number;
public Unit: string;
public Rate?: number;
public NeedsRate: boolean;
public Cost: number;
public RateKey: string;
public Chip: string;
public constructor(init?: Partial<EstimateMaterialLineView>) { (Object as any).assign(this, init); }
}
export class EstimateSubcontractView
{
public EstimateSubcontractID: number;
public TaskSeq: number;
public Vendor: string;
public Amount: number;
public Scope: string;
public constructor(init?: Partial<EstimateSubcontractView>) { (Object as any).assign(this, init); }
}
export class EstimateJobView
{
public Seq: number;
public WorkPackage: WorkPackageView;
public ItemNo: string;
public Name: string;
public Category: string;
public SourceRef: string;
public Unit: string;
public Quantity: number;
public PatternCode: string;
public Workdays: number;
public HoursPerDay: number;
public IsNight: boolean;
public WeeklyHours: number;
public OtFraction: number;
public Days: number;
public EffectiveProdPerDay?: number;
public CrewPremiumApplied: boolean;
public CrewCost: number;
public FringeCost: number;
public EquipmentCost: number;
public MaterialCost: number;
public SubcontractCost: number;
public Direct: number;
public PricingBasis: string;
public BenchmarkUnitPrice?: number;
public Crew: EstimateCrewLineView[] = [];
public Equipment: EstimateEquipmentLineView[] = [];
public Materials: EstimateMaterialLineView[] = [];
public Subcontracts: EstimateSubcontractView[] = [];
public constructor(init?: Partial<EstimateJobView>) { (Object as any).assign(this, init); }
}
export class BidScheduleLine
{
public ItemNo: string;
public Description: string;
public Unit: string;
public Quantity: number;
public UnitPrice: number;
public Extension: number;
public PricingBasis: string;
public BenchmarkDeltaPct?: number;
public BenchmarkFlagged: boolean;
public constructor(init?: Partial<BidScheduleLine>) { (Object as any).assign(this, init); }
}
export class EstimateVarianceLine
{
public Seq: number;
public ItemNo: string;
public Name: string;
public Unit: string;
public Quantity: number;
public OurUnitPrice: number;
public OurTotal: number;
public BenchmarkUnitPrice: number;
public MarketTotal: number;
public DeltaPct: number;
public RateMin?: number;
public RateMax?: number;
public SampleSize?: number;
public OutsideRange?: boolean;
public IsFloor: boolean;
public Severity: string;
public Note: string;
public constructor(init?: Partial<EstimateVarianceLine>) { (Object as any).assign(this, init); }
}
export class EstimateVarianceView
{
public Lines: EstimateVarianceLine[] = [];
public ItemsTotal: number;
public ItemsBenchmarked: number;
public CoverageValuePct: number;
public OursTotal: number;
public MarketTotal: number;
public AggregateDeltaPct?: number;
public FlooredCount: number;
public WatchCount: number;
public OutlierCount: number;
public CriticalCount: number;
public Note: string;
public constructor(init?: Partial<EstimateVarianceView>) { (Object as any).assign(this, init); }
}
export class IndicativeLine
{
public Seq: number;
public ItemNo: string;
public Name: string;
public Unit: string;
public Quantity: number;
public Source: string;
public UnitPrice: number;
public LineTotal: number;
public constructor(init?: Partial<IndicativeLine>) { (Object as any).assign(this, init); }
}
export class IndicativeBidView
{
public Lines: IndicativeLine[] = [];
public BottomUpCount: number;
public BottomUpTotal: number;
public BenchmarkCount: number;
public BenchmarkTotal: number;
public UncoveredCount: number;
public UncoveredFloorTotal: number;
public IndicativeTotal: number;
public FloorTotal: number;
public Note: string;
public constructor(init?: Partial<IndicativeBidView>) { (Object as any).assign(this, init); }
}
export class EstimateSummaryView
{
public Direct: number;
public OhpPct: number;
public OhpAmount: number;
public BondPct: number;
public BondAmount: number;
public ContingencyPct: number;
public ContingencyAmount: number;
public BidTotal: number;
public LoadFactor: number;
public MarginPct: number;
public constructor(init?: Partial<EstimateSummaryView>) { (Object as any).assign(this, init); }
}
export class EstimateTimingView
{
public TotalWorkdays: number;
public CalendarDays: number;
public Finish: string;
public Feasible: boolean;
public Deadline?: string;
public constructor(init?: Partial<EstimateTimingView>) { (Object as any).assign(this, init); }
}
export class EstimateReviewItemView
{
public TaskSeq: number;
public TaskName: string;
public Reason: string;
public Status: string;
public constructor(init?: Partial<EstimateReviewItemView>) { (Object as any).assign(this, init); }
}
export class EstimatingView
{
public RfpDocumentID: number;
public ProjectName: string;
public ClientName: string;
public BidDueDate: string;
public ProjectType: string;
public Settings: EstimateSettingsView;
public Jobs: EstimateJobView[] = [];
public Schedule: BidScheduleLine[] = [];
public ScheduleTotal: number;
public Variance: EstimateVarianceView;
public Indicative: IndicativeBidView;
public Summary: EstimateSummaryView;
public Timing: EstimateTimingView;
public NeedsRateCount: number;
public NeedsRateKeys: string[] = [];
public ReviewItems: EstimateReviewItemView[] = [];
public NeedsReviewCount: number;
public CanApprove: boolean;
public CanSeePay: boolean;
public constructor(init?: Partial<EstimatingView>) { (Object as any).assign(this, init); }
}
export class EstimateResponse
{
public ResponseStatus: ResponseStatus;
public View: EstimatingView;
public constructor(init?: Partial<EstimateResponse>) { (Object as any).assign(this, init); }
}
export class ApplyStartRequest
{
public RfpDocumentUID: string;
public StartDate: string;
public constructor(init?: Partial<ApplyStartRequest>) { (Object as any).assign(this, init); }
}
TypeScript ApplyStartRequest 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.
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
}
}