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

"use strict";
export class ComparableLettingView {
    /** @param {{ProjectNumber?:string,LettingDate?:string,AgeYears?:number,Parish?:string,LettingUrl?:string,WinnerTotal?:number,SpreadPct?:number,BidderCount?:number,SharedCount?:number,ItemCount?:number,OverlapPct?:number,MobilizationPct?:number,TrafficControlPct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProjectNumber;
    /** @type {string} */
    LettingDate;
    /** @type {number} */
    AgeYears;
    /** @type {string} */
    Parish;
    /** @type {string} */
    LettingUrl;
    /** @type {number} */
    WinnerTotal;
    /** @type {?number} */
    SpreadPct;
    /** @type {number} */
    BidderCount;
    /** @type {number} */
    SharedCount;
    /** @type {number} */
    ItemCount;
    /** @type {number} */
    OverlapPct;
    /** @type {?number} */
    MobilizationPct;
    /** @type {?number} */
    TrafficControlPct;
}
export class ComparablesSummaryView {
    /** @param {{MedianMobilizationPct?:number,MedianTrafficControlPct?:number,MedianSpreadPct?:number,AppliedMobilizationPct?:number,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    MedianMobilizationPct;
    /** @type {?number} */
    MedianTrafficControlPct;
    /** @type {?number} */
    MedianSpreadPct;
    /** @type {?number} */
    AppliedMobilizationPct;
    /** @type {string} */
    Note;
}
export class ComparablesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Comparables?:ComparableLettingView[],Summary?:ComparablesSummaryView}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ComparableLettingView[]} */
    Comparables = [];
    /** @type {ComparablesSummaryView} */
    Summary;
}
export class ComparablesRequest {
    /** @param {{RfpDocumentUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RfpDocumentUID;
}

JavaScript ComparablesRequest 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.

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
	}
}