Trendsic Platform Service

<back to all web services

EstimateRevisionCompareRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB}
EstimateRevisionCompareRequest Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentUIDpathGuidNo
RevisionApathintNo
RevisionBpathintNo
EstimateRevisionCompareResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CompareformEstimateRevisionCompareResultNo
EstimateRevisionCompareResult Parameters:
NameParameterData TypeRequiredDescription
RevisionAformintNo
RevisionBformintNo
LabelAformstringNo
LabelBformstringNo
TotalAformdecimalNo
TotalBformdecimalNo
TotalDeltaformdecimalNo
BidTotalAformdecimalNo
BidTotalBformdecimalNo
AddedformintNo
RemovedformintNo
ChangedformintNo
UnchangedformintNo
LinesformList<RevisionLineDelta>No
ScopeformProposalDiffNo
SummaryformstringNo
RevisionLineDelta Parameters:
NameParameterData TypeRequiredDescription
ItemNoformstringNo
DescriptionformstringNo
UnitformstringNo
ChangeformstringNo
QuantityAformdecimal?No
QuantityBformdecimal?No
UnitPriceAformdecimal?No
UnitPriceBformdecimal?No
ExtensionAformdecimalNo
ExtensionBformdecimalNo
QuantityDeltaformdecimalNo
UnitPriceDeltaformdecimalNo
ExtensionDeltaformdecimalNo
ProposalDiff Parameters:
NameParameterData TypeRequiredDescription
TasksAddedformList<string>No
TasksRemovedformList<string>No
TasksformList<TaskDiff>No
HasChangesformboolNo
TaskDiff Parameters:
NameParameterData TypeRequiredDescription
TaskNameformstringNo
PositionsAddedformList<string>No
PositionsRemovedformList<string>No
PositionsStaffedformList<string>No
EquipmentAddedformList<int>No
EquipmentRemovedformList<int>No
MaterialsAddedformList<int>No
MaterialsRemovedformList<int>No
HasChangesformboolNo

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.

GET /v1/Rfp/{RfpDocumentUID}/Estimate/Revisions/{RevisionA}/Compare/{RevisionB} 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
		}
	},
	Compare: 
	{
		RevisionA: 0,
		RevisionB: 0,
		LabelA: String,
		LabelB: String,
		TotalA: 0,
		TotalB: 0,
		TotalDelta: 0,
		BidTotalA: 0,
		BidTotalB: 0,
		Added: 0,
		Removed: 0,
		Changed: 0,
		Unchanged: 0,
		Lines: 
		[
			{
				ItemNo: String,
				Description: String,
				Unit: String,
				Change: String,
				QuantityA: 0,
				QuantityB: 0,
				UnitPriceA: 0,
				UnitPriceB: 0,
				ExtensionA: 0,
				ExtensionB: 0,
				QuantityDelta: 0,
				UnitPriceDelta: 0,
				ExtensionDelta: 0
			}
		],
		Scope: 
		{
			TasksAdded: 
			[
				String
			],
			TasksRemoved: 
			[
				String
			],
			Tasks: 
			[
				{
					TaskName: String,
					PositionsAdded: 
					[
						String
					],
					PositionsRemoved: 
					[
						String
					],
					PositionsStaffed: 
					[
						String
					],
					EquipmentAdded: 
					[
						0
					],
					EquipmentRemoved: 
					[
						0
					],
					MaterialsAdded: 
					[
						0
					],
					MaterialsRemoved: 
					[
						0
					],
					HasChanges: True
				}
			],
			HasChanges: True
		},
		Summary: String
	}
}