Trendsic Platform Service

<back to all web services

ComparablesRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Comparables
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ComparablesRequest
{
    open var RfpDocumentUID:UUID? = null
}

open class ComparablesResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Comparables:ArrayList<ComparableLettingView> = ArrayList<ComparableLettingView>()
    open var Summary:ComparablesSummaryView? = null
}

open class ComparableLettingView
{
    open var ProjectNumber:String? = null
    open var LettingDate:Date? = null
    open var AgeYears:BigDecimal? = null
    open var Parish:String? = null
    open var LettingUrl:String? = null
    open var WinnerTotal:BigDecimal? = null
    open var SpreadPct:BigDecimal? = null
    open var BidderCount:Int? = null
    open var SharedCount:Int? = null
    open var ItemCount:Int? = null
    open var OverlapPct:BigDecimal? = null
    open var MobilizationPct:BigDecimal? = null
    open var TrafficControlPct:BigDecimal? = null
}

open class ComparablesSummaryView
{
    open var MedianMobilizationPct:BigDecimal? = null
    open var MedianTrafficControlPct:BigDecimal? = null
    open var MedianSpreadPct:BigDecimal? = null
    open var AppliedMobilizationPct:BigDecimal? = null
    open var Note:String? = null
}

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