| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Estimate |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class BidScheduleLine
{
public virtual string ItemNo { get; set; }
public virtual string Description { get; set; }
public virtual string Unit { get; set; }
public virtual decimal Quantity { get; set; }
public virtual decimal UnitPrice { get; set; }
public virtual decimal Extension { get; set; }
public virtual string PricingBasis { get; set; }
public virtual decimal? BenchmarkDeltaPct { get; set; }
public virtual bool BenchmarkFlagged { get; set; }
}
public partial class EstimateCrewLineView
{
public virtual string Role { get; set; }
public virtual decimal Hours { get; set; }
public virtual decimal StHours { get; set; }
public virtual decimal OtHours { get; set; }
public virtual bool HasOt { get; set; }
public virtual bool PremiumApplied { get; set; }
public virtual bool NeedsRate { get; set; }
public virtual string RateKey { get; set; }
public virtual string Chip { get; set; }
public virtual decimal? Rrop { get; set; }
public virtual decimal? StCost { get; set; }
public virtual decimal? OtCost { get; set; }
public virtual decimal? Cost { get; set; }
public virtual decimal? FringeCost { get; set; }
}
public partial class EstimateEquipmentLineView
{
public virtual string Name { get; set; }
public virtual decimal Quantity { get; set; }
public virtual decimal? Rate { get; set; }
public virtual bool NeedsRate { get; set; }
public virtual decimal MobCost { get; set; }
public virtual decimal Cost { get; set; }
public virtual bool IsAvailabilityTracked { get; set; }
public virtual bool IsOwned { get; set; }
public virtual string AvailabilityLabel { get; set; }
public virtual string FreedFromProject { get; set; }
public virtual DateTime? AvailableFrom { get; set; }
public virtual string RateKey { get; set; }
public virtual string Chip { get; set; }
public virtual string RentalExplain { get; set; }
public virtual decimal UsageDays { get; set; }
public virtual decimal BilledDays { get; set; }
}
public partial class EstimateGetRequest
{
public virtual Guid RfpDocumentUID { get; set; }
}
public partial class EstimateJobView
{
public virtual int Seq { get; set; }
public virtual WorkPackageView WorkPackage { get; set; }
public virtual string ItemNo { get; set; }
public virtual string Name { get; set; }
public virtual string Category { get; set; }
public virtual string SourceRef { get; set; }
public virtual string Unit { get; set; }
public virtual decimal Quantity { get; set; }
public virtual string PatternCode { get; set; }
public virtual int Workdays { get; set; }
public virtual decimal HoursPerDay { get; set; }
public virtual bool IsNight { get; set; }
public virtual decimal WeeklyHours { get; set; }
public virtual decimal OtFraction { get; set; }
public virtual decimal Days { get; set; }
public virtual decimal? EffectiveProdPerDay { get; set; }
public virtual bool CrewPremiumApplied { get; set; }
public virtual decimal CrewCost { get; set; }
public virtual decimal FringeCost { get; set; }
public virtual decimal EquipmentCost { get; set; }
public virtual decimal MaterialCost { get; set; }
public virtual decimal SubcontractCost { get; set; }
public virtual decimal Direct { get; set; }
public virtual string PricingBasis { get; set; }
public virtual decimal? BenchmarkUnitPrice { get; set; }
public virtual List<EstimateCrewLineView> Crew { get; set; } = [];
public virtual List<EstimateEquipmentLineView> Equipment { get; set; } = [];
public virtual List<EstimateMaterialLineView> Materials { get; set; } = [];
public virtual List<EstimateSubcontractView> Subcontracts { get; set; } = [];
}
public partial class EstimateMaterialLineView
{
public virtual string Name { get; set; }
public virtual decimal Quantity { get; set; }
public virtual string Unit { get; set; }
public virtual decimal? Rate { get; set; }
public virtual bool NeedsRate { get; set; }
public virtual decimal Cost { get; set; }
public virtual string RateKey { get; set; }
public virtual string Chip { get; set; }
}
public partial class EstimateResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual EstimatingView View { get; set; }
}
public partial class EstimateReviewItemView
{
public virtual int TaskSeq { get; set; }
public virtual string TaskName { get; set; }
public virtual string Reason { get; set; }
public virtual string Status { get; set; }
}
public partial class EstimateSettingsView
{
public virtual int RfpEstimateID { get; set; }
public virtual DateTime? StartDate { get; set; }
public virtual DateTime? DeadlineDate { get; set; }
public virtual int WorkdaysPerWeek { get; set; }
public virtual decimal HoursPerDay { get; set; }
public virtual decimal WeatherPct { get; set; }
public virtual decimal OhpPct { get; set; }
public virtual decimal ContingencyPct { get; set; }
public virtual decimal BondPct { get; set; }
public virtual List<DateTime> Holidays { get; set; } = [];
public virtual DateTime? AppliedStartDate { get; set; }
}
public partial class EstimateSubcontractView
{
public virtual int EstimateSubcontractID { get; set; }
public virtual int TaskSeq { get; set; }
public virtual string Vendor { get; set; }
public virtual decimal Amount { get; set; }
public virtual string Scope { get; set; }
}
public partial class EstimateSummaryView
{
public virtual decimal Direct { get; set; }
public virtual decimal OhpPct { get; set; }
public virtual decimal OhpAmount { get; set; }
public virtual decimal BondPct { get; set; }
public virtual decimal BondAmount { get; set; }
public virtual decimal ContingencyPct { get; set; }
public virtual decimal ContingencyAmount { get; set; }
public virtual decimal BidTotal { get; set; }
public virtual decimal LoadFactor { get; set; }
public virtual decimal MarginPct { get; set; }
}
public partial class EstimateTimingView
{
public virtual decimal TotalWorkdays { get; set; }
public virtual int CalendarDays { get; set; }
public virtual DateTime Finish { get; set; }
public virtual bool Feasible { get; set; }
public virtual DateTime? Deadline { get; set; }
}
public partial class EstimateVarianceLine
{
public virtual int Seq { get; set; }
public virtual string ItemNo { get; set; }
public virtual string Name { get; set; }
public virtual string Unit { get; set; }
public virtual decimal Quantity { get; set; }
public virtual decimal OurUnitPrice { get; set; }
public virtual decimal OurTotal { get; set; }
public virtual decimal BenchmarkUnitPrice { get; set; }
public virtual decimal MarketTotal { get; set; }
public virtual decimal DeltaPct { get; set; }
public virtual decimal? RateMin { get; set; }
public virtual decimal? RateMax { get; set; }
public virtual int? SampleSize { get; set; }
public virtual bool? OutsideRange { get; set; }
public virtual bool IsFloor { get; set; }
public virtual string Severity { get; set; }
public virtual string Note { get; set; }
}
public partial class EstimateVarianceView
{
public virtual List<EstimateVarianceLine> Lines { get; set; } = [];
public virtual int ItemsTotal { get; set; }
public virtual int ItemsBenchmarked { get; set; }
public virtual decimal CoverageValuePct { get; set; }
public virtual decimal OursTotal { get; set; }
public virtual decimal MarketTotal { get; set; }
public virtual decimal? AggregateDeltaPct { get; set; }
public virtual int FlooredCount { get; set; }
public virtual int WatchCount { get; set; }
public virtual int OutlierCount { get; set; }
public virtual int CriticalCount { get; set; }
public virtual string Note { get; set; }
}
public partial class EstimatingView
{
public virtual int RfpDocumentID { get; set; }
public virtual string ProjectName { get; set; }
public virtual string ClientName { get; set; }
public virtual string BidDueDate { get; set; }
public virtual string ProjectType { get; set; }
public virtual EstimateSettingsView Settings { get; set; }
public virtual List<EstimateJobView> Jobs { get; set; } = [];
public virtual List<BidScheduleLine> Schedule { get; set; } = [];
public virtual decimal ScheduleTotal { get; set; }
public virtual EstimateVarianceView Variance { get; set; }
public virtual IndicativeBidView Indicative { get; set; }
public virtual EstimateSummaryView Summary { get; set; }
public virtual EstimateTimingView Timing { get; set; }
public virtual int NeedsRateCount { get; set; }
public virtual List<string> NeedsRateKeys { get; set; } = [];
public virtual List<EstimateReviewItemView> ReviewItems { get; set; } = [];
public virtual int NeedsReviewCount { get; set; }
public virtual bool CanApprove { get; set; }
public virtual bool CanSeePay { get; set; }
}
public partial class IndicativeBidView
{
public virtual List<IndicativeLine> Lines { get; set; } = [];
public virtual int BottomUpCount { get; set; }
public virtual decimal BottomUpTotal { get; set; }
public virtual int BenchmarkCount { get; set; }
public virtual decimal BenchmarkTotal { get; set; }
public virtual int UncoveredCount { get; set; }
public virtual decimal UncoveredFloorTotal { get; set; }
public virtual decimal IndicativeTotal { get; set; }
public virtual decimal FloorTotal { get; set; }
public virtual string Note { get; set; }
}
public partial class IndicativeLine
{
public virtual int Seq { get; set; }
public virtual string ItemNo { get; set; }
public virtual string Name { get; set; }
public virtual string Unit { get; set; }
public virtual decimal Quantity { get; set; }
public virtual string Source { get; set; }
public virtual decimal UnitPrice { get; set; }
public virtual decimal LineTotal { get; set; }
}
}
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.
GET /v1/Rfp/{RfpDocumentUID}/Estimate 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
}
},
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
}
}