Trendsic Platform Service

<back to all web services

ApplyAssemblyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/Estimate/Jobs/{TaskSeq}/assembly

export class ResourcedPosition
{
    public PositionTag: string;
    public Hours?: number;
    public CrewSize?: number;
    public Utilization?: number;
    public FixedDays?: number;
    public Headcount?: number;
    public SourceReference: string;
    public Notes: string;
    public IsInCatalog: boolean;
    public ContactID?: number;

    public constructor(init?: Partial<ResourcedPosition>) { (Object as any).assign(this, init); }
}

export class ResourcedEquipment
{
    public EquipmentID: number;
    public EquipmentName: string;
    public MakeModel: string;
    public Quantity?: number;
    public DurationDays?: number;
    public Utilization?: number;
    public FixedDays?: number;
    public SourceReference: string;
    public Notes: string;
    public IsInCatalog: boolean;
    public SuggestedEquipmentID: number;
    public SuggestedEquipmentName: string;

    public constructor(init?: Partial<ResourcedEquipment>) { (Object as any).assign(this, init); }
}

export class ResourcedMaterial
{
    public MaterialID: number;
    public MaterialName: string;
    public MakeModel: string;
    public Quantity?: number;
    public QuantityPerUnit?: number;
    public Unit: string;
    public SourceReference: string;
    public Notes: string;
    public IsInCatalog: boolean;
    public SuggestedMaterialID: number;
    public SuggestedMaterialName: string;

    public constructor(init?: Partial<ResourcedMaterial>) { (Object as any).assign(this, init); }
}

export class TaskResourcing
{
    public Positions: ResourcedPosition[] = [];
    public Equipment: ResourcedEquipment[] = [];
    public Materials: ResourcedMaterial[] = [];
    public ResourcedForQuantity?: number;
    public ProductionRatePerDay?: number;
    public FixedDays?: number;

    public constructor(init?: Partial<TaskResourcing>) { (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 EstimateCrewLineResult
{
    public Role: string;
    public Hours: number;
    public StHours: number;
    public OtHours: number;
    public Rrop: number;
    public StCost: number;
    public OtCost: number;
    public Cost: number;
    public FringeCost: number;
    public PremiumApplied: boolean;
    public HasOt: boolean;
    public NeedsRate: boolean;

    public constructor(init?: Partial<EstimateCrewLineResult>) { (Object as any).assign(this, init); }
}

export class EstimateEquipmentLineResult
{
    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 RentalExplain: string;
    public UsageDays: number;
    public BilledDays: number;

    public constructor(init?: Partial<EstimateEquipmentLineResult>) { (Object as any).assign(this, init); }
}

export class EstimateMaterialLineResult
{
    public Name: string;
    public Quantity: number;
    public Unit: string;
    public Rate?: number;
    public NeedsRate: boolean;
    public Cost: number;
    public RateKey: string;

    public constructor(init?: Partial<EstimateMaterialLineResult>) { (Object as any).assign(this, init); }
}

export class EstimateSubcontractLine
{
    public Vendor: string;
    public Amount: number;
    public Scope: string;

    public constructor(init?: Partial<EstimateSubcontractLine>) { (Object as any).assign(this, init); }
}

export class EstimateJobResult
{
    public Seq: number;
    public DependsOn: number[] = [];
    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 WorkPackage: WorkPackageView;
    public Crew: EstimateCrewLineResult[] = [];
    public Equipment: EstimateEquipmentLineResult[] = [];
    public Materials: EstimateMaterialLineResult[] = [];
    public Subcontracts: EstimateSubcontractLine[] = [];
    public CrewCost: number;
    public FringeCost: number;
    public EquipmentCost: number;
    public MaterialCost: number;
    public SubcontractCost: number;
    public Direct: number;
    public PricingBasis: string;
    public PricingRuleId: string;
    public PricingBandP25?: number;
    public PricingBandP75?: number;
    public PricingBandN?: number;
    public PricingBandLabel: string;
    public BenchmarkUnitPrice?: number;
    public BenchmarkRateMin?: number;
    public BenchmarkRateMax?: number;
    public BenchmarkSampleSize?: number;
    public BenchmarkP25?: number;
    public BenchmarkP75?: number;
    public BenchmarkBasis: string;
    public UnitPriceOverride?: number;
    public OverrideBasis: string;
    public ReferencePrice?: number;
    public ReferenceRangeMin?: number;
    public ReferenceRangeMax?: number;
    public ReferenceN?: number;
    public ReferenceDate?: string;
    public ReferenceBasis: string;
    public ReferenceUrl: string;

    public constructor(init?: Partial<EstimateJobResult>) { (Object as any).assign(this, init); }
}

export class ApplyAssemblyResponse
{
    public ResponseStatus: ResponseStatus;
    public TaskSeq: number;
    public TemplateUID?: string;
    public TemplateName: string;
    public Quantity: number;
    public Unit: string;
    public Resourcing: TaskResourcing;
    public Job: EstimateJobResult;
    public Headline: string;

    public constructor(init?: Partial<ApplyAssemblyResponse>) { (Object as any).assign(this, init); }
}

export class ApplyAssemblyRequest
{
    public RfpDocumentUID: string;
    public TaskSeq: number;
    public TemplateUID: string;

    public constructor(init?: Partial<ApplyAssemblyRequest>) { (Object as any).assign(this, init); }
}

TypeScript ApplyAssemblyRequest DTOs

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

{
	RfpDocumentUID: 00000000000000000000000000000000,
	TaskSeq: 0,
	TemplateUID: 00000000000000000000000000000000
}
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
		}
	},
	TaskSeq: 0,
	TemplateUID: 00000000000000000000000000000000,
	TemplateName: String,
	Quantity: 0,
	Unit: String,
	Resourcing: 
	{
		Positions: 
		[
			{
				PositionTag: String,
				Hours: 0,
				CrewSize: 0,
				Utilization: 0,
				FixedDays: 0,
				Headcount: 0,
				SourceReference: String,
				Notes: String,
				IsInCatalog: False,
				ContactID: 0
			}
		],
		Equipment: 
		[
			{
				EquipmentID: 0,
				EquipmentName: String,
				MakeModel: String,
				Quantity: 0,
				DurationDays: 0,
				Utilization: 0,
				FixedDays: 0,
				SourceReference: String,
				Notes: String,
				IsInCatalog: False,
				SuggestedEquipmentID: 0,
				SuggestedEquipmentName: String
			}
		],
		Materials: 
		[
			{
				MaterialID: 0,
				MaterialName: String,
				MakeModel: String,
				Quantity: 0,
				QuantityPerUnit: 0,
				Unit: String,
				SourceReference: String,
				Notes: String,
				IsInCatalog: False,
				SuggestedMaterialID: 0,
				SuggestedMaterialName: String
			}
		],
		ResourcedForQuantity: 0,
		ProductionRatePerDay: 0,
		FixedDays: 0
	},
	Job: 
	{
		Seq: 0,
		DependsOn: 
		[
			0
		],
		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,
		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
		},
		Crew: 
		[
			{
				Role: String,
				Hours: 0,
				StHours: 0,
				OtHours: 0,
				Rrop: 0,
				StCost: 0,
				OtCost: 0,
				Cost: 0,
				FringeCost: 0,
				PremiumApplied: False,
				HasOt: False,
				NeedsRate: False
			}
		],
		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,
				RentalExplain: String,
				UsageDays: 0,
				BilledDays: 0
			}
		],
		Materials: 
		[
			{
				Name: String,
				Quantity: 0,
				Unit: String,
				Rate: 0,
				NeedsRate: False,
				Cost: 0,
				RateKey: String
			}
		],
		Subcontracts: 
		[
			{
				Vendor: String,
				Amount: 0,
				Scope: String
			}
		],
		CrewCost: 0,
		FringeCost: 0,
		EquipmentCost: 0,
		MaterialCost: 0,
		SubcontractCost: 0,
		Direct: 0,
		PricingBasis: String,
		PricingRuleId: String,
		PricingBandP25: 0,
		PricingBandP75: 0,
		PricingBandN: 0,
		PricingBandLabel: String,
		BenchmarkUnitPrice: 0,
		BenchmarkRateMin: 0,
		BenchmarkRateMax: 0,
		BenchmarkSampleSize: 0,
		BenchmarkP25: 0,
		BenchmarkP75: 0,
		BenchmarkBasis: String,
		UnitPriceOverride: 0,
		OverrideBasis: String,
		ReferencePrice: 0,
		ReferenceRangeMin: 0,
		ReferenceRangeMax: 0,
		ReferenceN: 0,
		ReferenceDate: 0001-01-01,
		ReferenceBasis: String,
		ReferenceUrl: String
	},
	Headline: String
}