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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ComparableLettingView
    {
        public virtual string ProjectNumber { get; set; }
        public virtual DateTime LettingDate { get; set; }
        public virtual decimal AgeYears { get; set; }
        public virtual string Parish { get; set; }
        public virtual string LettingUrl { get; set; }
        public virtual decimal WinnerTotal { get; set; }
        public virtual decimal? SpreadPct { get; set; }
        public virtual int BidderCount { get; set; }
        public virtual int SharedCount { get; set; }
        public virtual int ItemCount { get; set; }
        public virtual decimal OverlapPct { get; set; }
        public virtual decimal? MobilizationPct { get; set; }
        public virtual decimal? TrafficControlPct { get; set; }
    }

    public partial class ComparablesRequest
    {
        public virtual Guid RfpDocumentUID { get; set; }
    }

    public partial class ComparablesResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<ComparableLettingView> Comparables { get; set; } = [];
        public virtual ComparablesSummaryView Summary { get; set; }
    }

    public partial class ComparablesSummaryView
    {
        public virtual decimal? MedianMobilizationPct { get; set; }
        public virtual decimal? MedianTrafficControlPct { get; set; }
        public virtual decimal? MedianSpreadPct { get; set; }
        public virtual decimal? AppliedMobilizationPct { get; set; }
        public virtual string Note { get; set; }
    }

}

C# 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"}}