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

export class ComparableLettingView
{
    public ProjectNumber: string;
    public LettingDate: string;
    public AgeYears: number;
    public Parish: string;
    public LettingUrl: string;
    public WinnerTotal: number;
    public SpreadPct?: number;
    public BidderCount: number;
    public SharedCount: number;
    public ItemCount: number;
    public OverlapPct: number;
    public MobilizationPct?: number;
    public TrafficControlPct?: number;

    public constructor(init?: Partial<ComparableLettingView>) { (Object as any).assign(this, init); }
}

export class ComparablesSummaryView
{
    public MedianMobilizationPct?: number;
    public MedianTrafficControlPct?: number;
    public MedianSpreadPct?: number;
    public AppliedMobilizationPct?: number;
    public Note: string;

    public constructor(init?: Partial<ComparablesSummaryView>) { (Object as any).assign(this, init); }
}

export class ComparablesResponse
{
    public ResponseStatus: ResponseStatus;
    public Comparables: ComparableLettingView[] = [];
    public Summary: ComparablesSummaryView;

    public constructor(init?: Partial<ComparablesResponse>) { (Object as any).assign(this, init); }
}

export class ComparablesRequest
{
    public RfpDocumentUID: string;

    public constructor(init?: Partial<ComparablesRequest>) { (Object as any).assign(this, init); }
}

TypeScript ComparablesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}