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
ComparablesRequest Parameters:
NameParameterData TypeRequiredDescription
RfpDocumentUIDpathGuidNo
ComparablesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ComparablesformList<ComparableLettingView>No
SummaryformComparablesSummaryViewNo
ComparableLettingView Parameters:
NameParameterData TypeRequiredDescription
ProjectNumberformstringNo
LettingDateformDateTimeNo
AgeYearsformdecimalNo
ParishformstringNo
LettingUrlformstringNo
WinnerTotalformdecimalNo
SpreadPctformdecimal?No
BidderCountformintNo
SharedCountformintNo
ItemCountformintNo
OverlapPctformdecimalNo
MobilizationPctformdecimal?No
TrafficControlPctformdecimal?No
ComparablesSummaryView Parameters:
NameParameterData TypeRequiredDescription
MedianMobilizationPctformdecimal?No
MedianTrafficControlPctformdecimal?No
MedianSpreadPctformdecimal?No
AppliedMobilizationPctformdecimal?No
NoteformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","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"}}