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.*;

public class dtos
{

    public static class ComparablesRequest
    {
        public UUID RfpDocumentUID = null;
        
        public UUID getRfpDocumentUID() { return RfpDocumentUID; }
        public ComparablesRequest setRfpDocumentUID(UUID value) { this.RfpDocumentUID = value; return this; }
    }

    public static class ComparablesResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<ComparableLettingView> Comparables = new ArrayList<ComparableLettingView>();
        public ComparablesSummaryView Summary = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ComparablesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<ComparableLettingView> getComparables() { return Comparables; }
        public ComparablesResponse setComparables(ArrayList<ComparableLettingView> value) { this.Comparables = value; return this; }
        public ComparablesSummaryView getSummary() { return Summary; }
        public ComparablesResponse setSummary(ComparablesSummaryView value) { this.Summary = value; return this; }
    }

    public static class ComparableLettingView
    {
        public String ProjectNumber = null;
        public Date LettingDate = null;
        public BigDecimal AgeYears = null;
        public String Parish = null;
        public String LettingUrl = null;
        public BigDecimal WinnerTotal = null;
        public BigDecimal SpreadPct = null;
        public Integer BidderCount = null;
        public Integer SharedCount = null;
        public Integer ItemCount = null;
        public BigDecimal OverlapPct = null;
        public BigDecimal MobilizationPct = null;
        public BigDecimal TrafficControlPct = null;
        
        public String getProjectNumber() { return ProjectNumber; }
        public ComparableLettingView setProjectNumber(String value) { this.ProjectNumber = value; return this; }
        public Date getLettingDate() { return LettingDate; }
        public ComparableLettingView setLettingDate(Date value) { this.LettingDate = value; return this; }
        public BigDecimal getAgeYears() { return AgeYears; }
        public ComparableLettingView setAgeYears(BigDecimal value) { this.AgeYears = value; return this; }
        public String getParish() { return Parish; }
        public ComparableLettingView setParish(String value) { this.Parish = value; return this; }
        public String getLettingUrl() { return LettingUrl; }
        public ComparableLettingView setLettingUrl(String value) { this.LettingUrl = value; return this; }
        public BigDecimal getWinnerTotal() { return WinnerTotal; }
        public ComparableLettingView setWinnerTotal(BigDecimal value) { this.WinnerTotal = value; return this; }
        public BigDecimal getSpreadPct() { return SpreadPct; }
        public ComparableLettingView setSpreadPct(BigDecimal value) { this.SpreadPct = value; return this; }
        public Integer getBidderCount() { return BidderCount; }
        public ComparableLettingView setBidderCount(Integer value) { this.BidderCount = value; return this; }
        public Integer getSharedCount() { return SharedCount; }
        public ComparableLettingView setSharedCount(Integer value) { this.SharedCount = value; return this; }
        public Integer getItemCount() { return ItemCount; }
        public ComparableLettingView setItemCount(Integer value) { this.ItemCount = value; return this; }
        public BigDecimal getOverlapPct() { return OverlapPct; }
        public ComparableLettingView setOverlapPct(BigDecimal value) { this.OverlapPct = value; return this; }
        public BigDecimal getMobilizationPct() { return MobilizationPct; }
        public ComparableLettingView setMobilizationPct(BigDecimal value) { this.MobilizationPct = value; return this; }
        public BigDecimal getTrafficControlPct() { return TrafficControlPct; }
        public ComparableLettingView setTrafficControlPct(BigDecimal value) { this.TrafficControlPct = value; return this; }
    }

    public static class ComparablesSummaryView
    {
        public BigDecimal MedianMobilizationPct = null;
        public BigDecimal MedianTrafficControlPct = null;
        public BigDecimal MedianSpreadPct = null;
        public BigDecimal AppliedMobilizationPct = null;
        public String Note = null;
        
        public BigDecimal getMedianMobilizationPct() { return MedianMobilizationPct; }
        public ComparablesSummaryView setMedianMobilizationPct(BigDecimal value) { this.MedianMobilizationPct = value; return this; }
        public BigDecimal getMedianTrafficControlPct() { return MedianTrafficControlPct; }
        public ComparablesSummaryView setMedianTrafficControlPct(BigDecimal value) { this.MedianTrafficControlPct = value; return this; }
        public BigDecimal getMedianSpreadPct() { return MedianSpreadPct; }
        public ComparablesSummaryView setMedianSpreadPct(BigDecimal value) { this.MedianSpreadPct = value; return this; }
        public BigDecimal getAppliedMobilizationPct() { return AppliedMobilizationPct; }
        public ComparablesSummaryView setAppliedMobilizationPct(BigDecimal value) { this.AppliedMobilizationPct = value; return this; }
        public String getNote() { return Note; }
        public ComparablesSummaryView setNote(String value) { this.Note = value; return this; }
    }

}

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