Trendsic Platform Service

<back to all web services

RfpRefineRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/Refine
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RfpLocation() = 
        member val Description:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Identifier:String = null with get,set

    [<AllowNullLiteral>]
    type RfpSchedule() = 
        member val BidDueDate:String = null with get,set
        member val EstimatedStartDate:String = null with get,set
        member val QuestionsDueDate:String = null with get,set
        member val ContractDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Notes:String = null with get,set

    [<AllowNullLiteral>]
    type RfpLineItem() = 
        member val ItemNumber:String = null with get,set
        member val Description:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val Unit:String = null with get,set
        member val Category:String = null with get,set
        member val SourceReference:String = null with get,set

    [<AllowNullLiteral>]
    type RfpBidConstraint() = 
        member val Constraint:String = null with get,set
        member val Detail:String = null with get,set

    [<AllowNullLiteral>]
    type RfpBrief() = 
        member val ProjectTitle:String = null with get,set
        member val SolicitationNumber:String = null with get,set
        member val IssuingOrganization:String = null with get,set
        member val ProjectType:String = null with get,set
        member val Summary:String = null with get,set
        member val Locations:ResizeArray<RfpLocation> = new ResizeArray<RfpLocation>() with get,set
        member val Schedule:RfpSchedule = null with get,set
        member val LineItems:ResizeArray<RfpLineItem> = new ResizeArray<RfpLineItem>() with get,set
        member val BidConstraints:ResizeArray<RfpBidConstraint> = new ResizeArray<RfpBidConstraint>() with get,set
        member val SpecialRequirements:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type ResourcedPosition() = 
        member val PositionTag:String = null with get,set
        member val Hours:Nullable<Double> = new Nullable<Double>() with get,set
        member val Headcount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SourceReference:String = null with get,set
        member val Notes:String = null with get,set
        member val IsInCatalog:Boolean = new Boolean() with get,set
        member val ContactID:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type ResourcedEquipment() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val EquipmentName:String = null with get,set
        member val MakeModel:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val DurationDays:Nullable<Double> = new Nullable<Double>() with get,set
        member val SourceReference:String = null with get,set
        member val Notes:String = null with get,set
        member val IsInCatalog:Boolean = new Boolean() with get,set
        member val SuggestedEquipmentID:Int32 = new Int32() with get,set
        member val SuggestedEquipmentName:String = null with get,set

    [<AllowNullLiteral>]
    type ResourcedMaterial() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val MaterialName:String = null with get,set
        member val MakeModel:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val Unit:String = null with get,set
        member val SourceReference:String = null with get,set
        member val Notes:String = null with get,set
        member val IsInCatalog:Boolean = new Boolean() with get,set
        member val SuggestedMaterialID:Int32 = new Int32() with get,set
        member val SuggestedMaterialName:String = null with get,set

    [<AllowNullLiteral>]
    type TaskResourcing() = 
        member val Positions:ResizeArray<ResourcedPosition> = new ResizeArray<ResourcedPosition>() with get,set
        member val Equipment:ResizeArray<ResourcedEquipment> = new ResizeArray<ResourcedEquipment>() with get,set
        member val Materials:ResizeArray<ResourcedMaterial> = new ResizeArray<ResourcedMaterial>() with get,set

    [<AllowNullLiteral>]
    type ProposedTask() = 
        member val Seq:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val Unit:String = null with get,set
        member val SourceItemNumber:String = null with get,set
        member val SourceReference:String = null with get,set
        member val Notes:String = null with get,set
        member val Resourcing:TaskResourcing = null with get,set
        member val DurationDays:Nullable<Double> = new Nullable<Double>() with get,set
        member val DependsOn:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val EstimatedStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EstimatedEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ProjectProposal() = 
        member val RfpDocumentID:Int32 = new Int32() with get,set
        member val Mode:String = null with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChangeOrderID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ProjectName:String = null with get,set
        member val ClientName:String = null with get,set
        member val ProjectType:String = null with get,set
        member val ProjectLocation:String = null with get,set
        member val Scope:String = null with get,set
        member val ProjectDescription:String = null with get,set
        member val ContractDurationDays:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val BidDueDate:String = null with get,set
        member val EstimatedStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EstimatedEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Tasks:ResizeArray<ProposedTask> = new ResizeArray<ProposedTask>() with get,set

    [<AllowNullLiteral>]
    type CostRange() = 
        member val Min:Double = new Double() with get,set
        member val Max:Double = new Double() with get,set
        member val Mid:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type PricedPosition() = 
        member val PositionTag:String = null with get,set
        member val Hours:Double = new Double() with get,set
        member val HasInternalRate:Boolean = new Boolean() with get,set
        member val RateMin:Nullable<Double> = new Nullable<Double>() with get,set
        member val RateMax:Nullable<Double> = new Nullable<Double>() with get,set
        member val RateAvg:Nullable<Double> = new Nullable<Double>() with get,set
        member val ContactCount:Int32 = new Int32() with get,set
        member val Cost:CostRange = null with get,set
        member val MarketRateReference:Nullable<Double> = new Nullable<Double>() with get,set

    [<AllowNullLiteral>]
    type PricedEquipment() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val EquipmentName:String = null with get,set
        member val Quantity:Double = new Double() with get,set
        member val DurationDays:Nullable<Double> = new Nullable<Double>() with get,set
        member val RateType:String = null with get,set
        member val BilledRate:Nullable<Double> = new Nullable<Double>() with get,set
        member val CostRate:Nullable<Double> = new Nullable<Double>() with get,set
        member val HasRate:Boolean = new Boolean() with get,set
        member val IsInCatalog:Boolean = new Boolean() with get,set
        member val Cost:Double = new Double() with get,set
        member val CompanyCost:Double = new Double() with get,set
        member val Margin:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type PricedMaterial() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val MaterialName:String = null with get,set
        member val Quantity:Double = new Double() with get,set
        member val UnitCost:Nullable<Double> = new Nullable<Double>() with get,set
        member val HasRate:Boolean = new Boolean() with get,set
        member val IsInCatalog:Boolean = new Boolean() with get,set
        member val Cost:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type PricedTask() = 
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val Positions:ResizeArray<PricedPosition> = new ResizeArray<PricedPosition>() with get,set
        member val Equipment:ResizeArray<PricedEquipment> = new ResizeArray<PricedEquipment>() with get,set
        member val Materials:ResizeArray<PricedMaterial> = new ResizeArray<PricedMaterial>() with get,set
        member val Subtotal:CostRange = null with get,set

    [<AllowNullLiteral>]
    type PricedProposal() = 
        member val RfpDocumentID:Int32 = new Int32() with get,set
        member val ProjectName:String = null with get,set
        member val Currency:String = null with get,set
        member val Tasks:ResizeArray<PricedTask> = new ResizeArray<PricedTask>() with get,set
        member val Total:CostRange = null with get,set
        member val PositionsNeedingRate:Int32 = new Int32() with get,set
        member val EquipmentNotInCatalog:Int32 = new Int32() with get,set
        member val MaterialsNotInCatalog:Int32 = new Int32() with get,set
        member val PositionsNotInCatalog:Int32 = new Int32() with get,set
        member val EquipmentMargin:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type CrewPlanLine() = 
        member val PositionTag:String = null with get,set
        member val Needed:Int32 = new Int32() with get,set
        member val NaiveTotal:Int32 = new Int32() with get,set
        member val TaskAssignments:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RfpRefineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val RfpDocumentID:Int32 = new Int32() with get,set
        member val Layer:String = null with get,set
        member val Mode:String = null with get,set
        member val TurnCount:Int32 = new Int32() with get,set
        member val Brief:RfpBrief = null with get,set
        member val Proposal:ProjectProposal = null with get,set
        member val Pricing:PricedProposal = null with get,set
        member val CrewPlan:ResizeArray<CrewPlanLine> = new ResizeArray<CrewPlanLine>() with get,set
        member val CacheReadTokens:Int64 = new Int64() with get,set
        member val CacheCreationTokens:Int64 = new Int64() with get,set
        member val InputTokens:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type RfpRefineRequest() = 
        member val RfpDocumentUID:String = null with get,set
        member val Layer:String = null with get,set
        member val Mode:String = null with get,set
        member val Instruction:String = null with get,set

F# RfpRefineRequest 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}/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
}