Trendsic Platform Service

ComparablesRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/Rfp/{RfpDocumentUID}/Comparables

**ComparablesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
RfpDocumentUID	path	Guid	No

**ComparablesResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Comparables	form	List<ComparableLettingView>	No
Summary	form	ComparablesSummaryView	No

**ComparableLettingView** Parameters:
Name	Parameter	Data Type	Required
ProjectNumber	form	string	No
LettingDate	form	DateTime	No
AgeYears	form	decimal	No
Parish	form	string	No
LettingUrl	form	string	No
WinnerTotal	form	decimal	No
SpreadPct	form	decimal?	No
BidderCount	form	int	No
SharedCount	form	int	No
ItemCount	form	int	No
OverlapPct	form	decimal	No
MobilizationPct	form	decimal?	No
TrafficControlPct	form	decimal?	No

**ComparablesSummaryView** Parameters:
Name	Parameter	Data Type	Required
MedianMobilizationPct	form	decimal?	No
MedianTrafficControlPct	form	decimal?	No
MedianSpreadPct	form	decimal?	No
AppliedMobilizationPct	form	decimal?	No
Note	form	string	No

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}/Comparables 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
		}
	},
	Comparables: 
	[
		{
			ProjectNumber: String,
			LettingDate: 0001-01-01,
			AgeYears: 0,
			Parish: String,
			LettingUrl: String,
			WinnerTotal: 0,
			SpreadPct: 0,
			BidderCount: 0,
			SharedCount: 0,
			ItemCount: 0,
			OverlapPct: 0,
			MobilizationPct: 0,
			TrafficControlPct: 0
		}
	],
	Summary: 
	{
		MedianMobilizationPct: 0,
		MedianTrafficControlPct: 0,
		MedianSpreadPct: 0,
		AppliedMobilizationPct: 0,
		Note: String
	}
}